Reports

Generate a branded PDF analytics report for the workspace. This group covers PDF report generation specifically — for raw JSON analytics data, see Analytics.

Base URL


https://api.voxburst.io/v1/reports

Authentication: Requires the analytics:read scope (shared with /v1/analytics — this group has no scope of its own). Requires the PRO or AGENCY plan — other plans receive a plan-upgrade error.

Generate a PDF Analytics Report

GET /v1/reports/pdf

Query Parameters

Parameter	Type	Required	Description
`startDate`	string	No	ISO 8601 datetime. Defaults to 30 days before `endDate`.
`endDate`	string	No	ISO 8601 datetime. Defaults to now.


curl "https://api.voxburst.io/v1/reports/pdf?startDate=2026-07-01T00:00:00Z&endDate=2026-08-01T00:00:00Z" \
  -H "Authorization: Bearer vb_live_xxxxxxxxxxxxx" \
  -o voxburst-report.pdf

Response

Returns the raw PDF file (Content-Type: application/pdf) with Content-Disposition: attachment; filename="voxburst-report-<date>.pdf".

AGENCY plan reports are white-labeled — the “Powered by VoxBurst” footer is omitted. PRO plan reports include the footer.

Error Codes

Status	Cause
`403`	Workspace plan does not include the `pdf_reports` feature (requires PRO or AGENCY)