Skip to main content
GET
Get scheduler analytics

Authorizations

Authorization
string
header
required

API key in the format avoca_<64 hex characters>

Headers

x-team-id
integer

Target team ID. Required for multi-team (enterprise_all_teams / portfolio_all_teams) keys on v0 endpoints; single-team keys are locked to their team and omit it.

Query Parameters

start_date
string<date-time>

Start of date range (ISO 8601; default 7 days ago)

end_date
string<date-time>

End of date range (ISO 8601; default now)

timezone
string
default:America/New_York

IANA timezone for date calculations (default America/New_York)

scheduler_id
integer

Filter to a specific scheduler

metrics
string

Comma-separated metric blocks to include (default: all)

limit
integer
default:100

Results per page (default 100, max 1000)

Required range: x <= 1000
offset
integer
default:0

Pagination offset (default 0)

Response

Requested analytics blocks

data
object

Metric blocks are present only when requested via the metrics parameter (default: all).

pagination
object
metadata
object