Skip to content

Conventions

Lists that can grow without bound are paged with a cursor. Pass the next_cursor from one response as cursor in the next request, with the same filters; stop when next_cursor is null. limit sets the page size (up to 5000, default 1000).

{ "items": [ … ], "next_cursor": "WyIyMDI2LTEwLTE0…" }

Small lists (teams, campaigns, dialers, aggregates) return { "items": [ … ] } in one go.

  • 600 requests per minute per key by default; 429 responses carry Retry-After.
  • /calls takes at most a 31-day window per request.
  • /facts/agent-daily takes at most 92 days; /performance/* and /facts/days 400 days.
  • An aggregate that would return more than limit groups answers 400: narrow the range, add filters or group by less.
  • Every query has a 10-second time limit.

Errors share one shape. Quote request_id when you report a problem; send your own X-Request-ID header to tie our logs to yours.

{ "error_code": "BAD_REQUEST", "message": "Window too large: at most 31 days per request", "request_id": "…" }

Timestamps are ISO 8601 in UTC. Send them with a timezone (Z or +05:00); values without one are read as UTC. Daily figures use calendar days in the deployment’s timezone, returned as facts_timezone by /meta.

Changes within v2 only add things: new endpoints, new fields, new filter values. Ignore fields you do not know. Anything that would break a client ships as a new version. Every change is listed in the API changelog.