For AI agents: markdown of this page — /docs-content-en/scrum/metrics/burn-down.md documentation index — /llms.txt
Get burndown chart data
GET /v1/scrum/groups/:groupId/burn-down
Returns the scrum project sprint used to build the burndown chart: the current active sprint, or the last completed one if there is no active sprint.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ParametergroupId (path) |
Typenumber | Requiredyes | DescriptionScrum project ID. List: GET /v1/workgroups |
Examples
curl — personal key
curl "https://vibecode.bitrix24.com/v1/scrum/groups/45/burn-down" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth application
curl "https://vibecode.bitrix24.com/v1/scrum/groups/45/burn-down" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — personal key
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/groups/45/burn-down', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log(data.sprint ? `${data.sprint.name}: ${data.sprint.status}` : 'No sprints')
JavaScript — OAuth application
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/groups/45/burn-down', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data } = await res.json()
console.log(data.sprint ? `${data.sprint.name}: ${data.sprint.status}` : 'No sprints')
Response fields
| Field | Type | Description |
|---|---|---|
Fieldsuccess |
Typeboolean | DescriptionAlways true on success |
Fielddata.sprint |
Typeobject | null | DescriptionThe sprint for the chart, or null if the project has neither an active nor a completed sprint. A non-scrum workgroup the user belongs to also returns null |
Fielddata.sprint.id |
Typenumber | DescriptionSprint ID. Full data: GET /v1/scrum/sprints/:id |
Fielddata.sprint.groupId |
Typenumber | DescriptionScrum project ID |
Fielddata.sprint.entityType |
Typestring | DescriptionRecord type, sprint |
Fielddata.sprint.name |
Typestring | DescriptionSprint name |
Fielddata.sprint.sort |
Typenumber | DescriptionSprint order within the project |
Fielddata.sprint.createdBy |
Typenumber | DescriptionID of the sprint author. List: GET /v1/users |
Fielddata.sprint.modifiedBy |
Typenumber | DescriptionID of the employee who last modified the sprint. List: GET /v1/users |
Fielddata.sprint.dateStart |
Typestring | DescriptionSprint start in ISO 8601 format |
Fielddata.sprint.dateEnd |
Typestring | DescriptionSprint end in ISO 8601 format |
Fielddata.sprint.status |
Typestring | Descriptionactive — the sprint is in progress, completed — finished |
Fielddata.sprint.info |
Typeobject | DescriptionAn empty object in the sprints checked |
Fielddata.sprint.children |
Typearray | DescriptionAn empty array in the sprints checked |
Fielddata.sprint.tmpId |
Typestring | DescriptionAn empty string in the sprints checked |
Response example
Active sprint:
{
"success": true,
"data": {
"sprint": {
"id": 11,
"groupId": 45,
"entityType": "sprint",
"name": "Sprint 3",
"sort": 0,
"createdBy": 29,
"modifiedBy": 29,
"dateStart": "2023-09-15T01:00:00+00:00",
"dateEnd": "2023-09-29T01:00:00+00:00",
"status": "active",
"info": {},
"children": [],
"tmpId": ""
}
}
}
Project without sprints:
{
"success": true,
"data": {
"sprint": null
}
}
Error response example
422 — the project does not exist or the user has no access to it:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "You do not have access.",
"b24Code": "TASKS_SCS_02"
}
}
Errors
| HTTP | Code | Description |
|---|---|---|
| HTTP400 | CodeINVALID_PARAMS |
DescriptiongroupId is not a positive integer |
| HTTP401 | CodeMISSING_API_KEY |
DescriptionX-Api-Key is not provided |
| HTTP401 | CodeTOKEN_MISSING |
DescriptionThe key has no tokens configured |
| HTTP403 | CodeSCOPE_DENIED |
DescriptionThe key lacks the task scope |
| HTTP422 | CodeBITRIX_ERROR |
DescriptionThe project does not exist or the user has no access to it. error.b24Code is TASKS_SCS_02 |
For the full list of common API errors, see Errors.
Known specifics
- Chart points are built from the sprint tasks and their story points:
GET /v1/tasks?filter[groupId]=45returns the project tasks, andGET /v1/scrum/tasks/:taskIdreturns a task's sprint and story points.