Skip to main content
GET
/
api
/
v1
/
boards
/
{board_id}
/
analytics
/
velocity
Board Velocity
curl --request GET \
  --url https://api.example.com/api/v1/boards/{board_id}/analytics/velocity \
  --header 'Authorization: Bearer <token>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
board_id
string
required

Query Parameters

​
weeks
integer
default:12
Required range: 1 <= x <= 52
​
days
integer
default:30
Required range: 1 <= x <= 365
​
granularity
string
default:week

'week' (default) buckets by Monday-aligned week and uses weeks; 'day' buckets per calendar day and uses days.

​
from
string | null
​
to
string | null

Response

Successful Response

Last modified on May 17, 2026