Report preview page image

GET/api/v1/reports/preview-page

Return one rendered page of a report/export preview as a raw PNG image. Validates ownership exactly like /download. Renders and caches on a cache miss.

Operation ID: get_report_preview_page_api_v1_reports_preview_page_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

s3_keystringrequired
pageintegerrequired: 1-based page number.

Responses

200Successful Response

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/reports/preview-page

bash

curl -X GET 'https://api.ondayzero.com/api/v1/reports/preview-page' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'