Skip to main content

Download Support Insights Report

GET 
/api/support/insights-reports/:report/download/:format

Download a file of a ready report as an attachment:

  • html — self-contained document (works offline, includes the person filter)
  • pdf — print version (404 if the PDF could not be rendered; the other formats remain available)
  • csv — zip of tickets, monthly, features, causes, usage_matrix, people, uptime_daily and findings CSVs plus README.txt
  • json — zip of pack.json, fields.md (field dictionary) and ask-your-ai.md (how to use the data with your own AI)
Required scope: support:read

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

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​

OK

Response Headers
    Content-Type