Custom reports
API token passed as Authorization: Bearer <token>.
The token must have the entityQuery scope enabled.
Tokens can be provisioned at https://app.swarmia.com/settings/api-tokens.
UUID of a custom report.
a1b2c3d4-e5f6-7890-abcd-ef1234567890Response format.
jsonPossible values: Start of the reporting period (inclusive). When provided
together with timeframe.end, overrides all timeframe
filters embedded in the report. When omitted, the
report's original timeframes are used as-is.
2026-01-01End of the reporting period (inclusive). Must be provided
together with timeframe.start.
2026-02-01IANA timezone used to interpret the date-only timeframe.start
and timeframe.end values and for time bucketing. Defaults to UTC.
UTCExample: America/New_YorkSuccessful response.
Invalid or unknown parameters.
Missing or invalid API token.
Report not found.
Last updated
Was this helpful?