Report preview availability

GET/api/v1/reports/preview-info

Report whether a server-rendered PNG preview is available for a report/export file, and how many pages it has. Validates ownership exactly like /download. Renders and caches every page (capped at 20) on the first call for a key; later calls are served from cache.

Operation ID: get_report_preview_info_api_v1_reports_preview_info_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

Responses

200Successful Response

Schema: SuccessEnvelope_ReportPreviewInfoResponse_

successboolean
messagestring
codestring
dataReportPreviewInfoResponse

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-info

bash

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