Skip to content

Commit 15d729d

Browse files
committed
Summary volume update
adding in examples of responses and the explanations of the fields
1 parent 8dbea48 commit 15d729d

File tree

1 file changed

+43
-12
lines changed

1 file changed

+43
-12
lines changed

source/includes/_activity.md

Lines changed: 43 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ field | description | type
174174

175175
**Summary Volume**
176176

177-
Description: daily volume of objects in each workflow state.
177+
Description: daily volume of objects in each workflow state. Your response will contain an array for each state, and within that state an object for each period (i.e. each day).
178178

179179
```text
180180
curl -H "Content-Type: application/json" -H "Auth-Api-Token: 12345678-1234-1234-1234-123456789" https://api.lexer.io/v1/activity/reports -d '
@@ -186,20 +186,51 @@ curl -H "Content-Type: application/json" -H "Auth-Api-Token: 12345678-1234-1234-
186186
```
187187
**Type:** states_volume
188188

189+
190+
```json
191+
{
192+
"closed": [
193+
{
194+
"state": "closed",
195+
"value": 174,
196+
"date_range": {
197+
"date_from": "2018-04-27 00:00"
198+
}
199+
},
200+
{
201+
"state": "closed",
202+
"value": 234,
203+
"date_range": {
204+
"date_from": "2018-04-28 00:00"
205+
}
206+
},
207+
{
208+
"state": "closed",
209+
"value": 255,
210+
"date_range": {
211+
"date_from": "2018-04-29 00:00"
212+
}
213+
},
214+
{
215+
"state": "closed",
216+
"value": 108,
217+
"date_range": {
218+
"date_from": "2018-04-30 00:00"
219+
}
220+
}
221+
]
222+
}
223+
```
224+
189225
Property | Description | Type |
190226
---------|-------------|------|
191-
field | description | type
192-
field | description | type
193-
field | description | type
194-
field | description | type
195-
field | description | type
196-
field | description | type
197-
field | description | type
198-
field | description | type
199-
field | description | type
200-
field | description | type
201-
field | description | type
227+
state | workflow state | string
228+
value | number of objects in this state | integer
229+
date_range | date for value | string
202230

231+
**Notes:**
232+
> Most results will be found in the 'closed' state. We suggest using this volume to map total volume over time.
233+
> If your query range is less than 4 days the time intervals will be reduced from days to hours.
203234
204235

205236

0 commit comments

Comments
 (0)