DocsAPI reference

Agent report

The whole dashboard as a file, in any of five formats.

get/api/agents/{agent_id}/report
Authentication
Bearer token
Retries
Safe to repeat
Body
None
Version
2026-09-03

All five are renderings of one Report object, which is the property that matters: a customer who exports the same period as a spreadsheet and as a PDF and finds two different numbers has learned something about this product that no amount of later accuracy undoes.

advanced by default here, unlike the screen. Somebody who chose to download a file has asked for the data; the mode switch inside the HTML export still lets them read it simply.

Path parameters#

  • agent_idstringrequired

Query parameters#

  • formatstring

    Default: html·Pattern: ^(html|xlsx|pdf|csv|json)$

  • daysinteger

    Default: 30·≥ 1 and ≤ 365

  • modestring

    Default: advanced·Pattern: ^(simple|advanced)$

  • include_usageboolean

    Default: true

Responses#

  • 200OKapplication/json

    any

    5 response headers
    RateLimit-Limit

    Requests permitted in the current window.

    RateLimit-Remaining

    Requests left in the current window. Back off before it reaches 0.

    RateLimit-Reset

    Seconds until the current window resets.

    X-API-Version

    The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

    X-Request-ID

    Quote this in a support request to identify the call.

  • 422Validation error

    The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

  • validation_error · 422 — The payload was well-formed JSON but failed schema validation.
  • unauthenticated · 401 — The request carried no API key, or one the API could not verify.
  • forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
  • rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Insights endpoints#

Something unclear or missing? Tell us and we’ll fix it.