Skip to main content

Generate Support Insights Report

POST 
/api/support/insights-reports

Queue a new report for a date range. Generation runs in the background, makes no AI or third-party call, and always gives the same result for the same data. Track progress with the returned tracked_job_log_id (Background jobs API) or poll Get Support Insights Report.

Required scope: support:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Rules: from ≤ to ≤ today (account timezone), at most 36 months, from ≥ 2015-01-01. Validation messages name the broken rule: "Pick a start date before the end date.", "The end date can't be in the future.", "Reports can cover at most 36 months — narrow the range.", "Reports can start on 1 January 2015 at the earliest." Only one report can be in progress at a time (409), and an account can generate 10 per hour (429 with Retry-After).

Access: requires the support_insights.access permission (admins have it by default; it is not part of Full Access). Personal Access Tokens need support:read for reads and support:write for changes. Runs in tenant context — send the X-Tenant-Id header or call from a tenant subdomain.

Request​

Responses​

Accepted

Response Headers
    Content-Type