Skip to content
ShaireDevelopers
Get a token

reports

6 endpoints.

get/api/reports/burndown#

reports:read

Query

cycleIdstring · uuid
milestoneIdstring · uuid
Request
curl https://api.shairelabs.com/api/reports/burndown \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · BurndownReport

startsOnstring*
endsOnstring*
daysobject[]*
[item]object
daystring*
remaininginteger*
scopeinteger*
remainingEstimatenumber | null*
scopeEstimatenumber | null*
idealFrominteger*
idealFromEstimatenumber | null*
unestimatedinteger*

Also answers 401 and 403. SeeErrors.

get/api/reports/cycle-time#

reports:read

Query

listIdstring · uuid
milestoneIdstring · uuid
cycleIdstring · uuid
sincestring · date*
Request
curl https://api.shairelabs.com/api/reports/cycle-time?since=2026-01-31 \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · CycleTimeReport

sincestring*
completedinteger*
medianCycleSecondsinteger | null*
p85CycleSecondsinteger | null*
medianLeadSecondsinteger | null*
p85LeadSecondsinteger | null*
statusesobject[]*
[item]object
statusIdstring · uuid*
namestring*
colorstring*
systemicStatestring*
openin_progressdonecanceled
groupNamestring*
ticketsinteger*
medianSecondsinteger*
p85Secondsinteger*
ticketsobject[]*
[item]object
ticketIdstring · uuid*
keystring*
completedAtstring*
cycleSecondsinteger | null*
leadSecondsinteger*

Also answers 401 and 403. SeeErrors.

get/api/reports/throughput#

reports:read

Query

sincestring · date*
assigneeIdstring · uuid
Request
curl https://api.shairelabs.com/api/reports/throughput?since=2026-01-31 \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · ThroughputReport

sincestring*
completedinteger*

Also answers 401 and 403. SeeErrors.

get/api/reports/time#

reports:read

Query

listIdstring · uuid
milestoneIdstring · uuid
cycleIdstring · uuid
fromstring · date-time*
tostring · date-time*
Request
curl https://api.shairelabs.com/api/reports/time?from=example&to=example \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · TimeReport

fromstring*
tostring*
totalSecondsinteger | null*
peopleobject[]*
[item]object
userIdstring · uuid*
secondsinteger*
entriesinteger*
ticketsobject[]*
[item]object
ticketIdstring · uuid*
keystring*
titlestring*
secondsinteger*
estimatenumber | null*

Also answers 401 and 403. SeeErrors.

get/api/reports/velocity#

reports:read

Query

limitinteger
default 6 · min 1 · max 24
Request
curl https://api.shairelabs.com/api/reports/velocity \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · VelocityReport

cyclesobject[]*
[item]object
cycleIdstring · uuid*
namestring*
numberinteger*
startsOnstring*
endsOnstring*
completedinteger*
committedinteger*
completedEstimatenumber | null*
committedEstimatenumber | null*
capacitynumber | null*
averageCompletednumber | null*
averageCompletedEstimatenumber | null*

Also answers 401 and 403. SeeErrors.

get/api/reports/workload#

reports:read

Query

listIdstring · uuid
milestoneIdstring · uuid
cycleIdstring · uuid
Request
curl https://api.shairelabs.com/api/reports/workload \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · WorkloadReport

rowsobject[]*
[item]object
userIdstring · uuid | null*
openinteger*
inProgressinteger*
totalinteger*
overdueinteger*
estimateTotalnumber | null*
unestimatedinteger*

Also answers 401 and 403. SeeErrors.