Skip to content

Commit 743fc32

Browse files
v1.14: Add new /batches response fields (#3213)
1 parent 991e87a commit 743fc32

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

reference/api/batches.mdx

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,10 @@ The `/batches` route gives information about the progress of batches of [asynchr
2626
},
2727
"indexUids": {
2828
"INDEX_NAME": 1
29-
}
29+
},
30+
"progressTrace": { },
31+
"writeChannelCongestion": { },
32+
"internalDatabaseSizes": { }
3033
},
3134
"duration": "PT0.250518S",
3235
"startedAt": "2024-12-10T15:20:30.18182Z",
@@ -103,6 +106,18 @@ List with the `types` of tasks contained in the batch.
103106

104107
List of the number of tasks in the batch separated by the indexes they affect.
105108

109+
#### `progressTrace`
110+
111+
List with full paths for each operation performed in the batch, together with the processing time in human-readable format.
112+
113+
#### `writeChannelCongestion`
114+
115+
Object containing information on write operations computed during indexing. Can be useful when diagnosing performance issues associated with write speeds.
116+
117+
#### `internalDatabaseSizes`
118+
119+
Size of each internal database, including by how much it changed after a batch was processed.
120+
106121
### `duration`
107122

108123
**Type**: String<br />
@@ -191,7 +206,10 @@ For example, `?uids=0` returns a batch containing the task with a `taskUid` equa
191206
},
192207
"indexUids": {
193208
"INDEX_NAME": 1
194-
}
209+
},
210+
"progressTrace": { },
211+
"writeChannelCongestion": { },
212+
"internalDatabaseSizes": { }
195213
},
196214
"duration": "PT0.110083S",
197215
"startedAt": "2024-12-10T15:49:04.995321Z",

0 commit comments

Comments
 (0)