{"openapi":"3.1.0","info":{"title":"GET /api/v1/reports/preview-info","version":"1.0.0","description":"Report preview availability"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/reports/preview-info":{"get":{"tags":["reports"],"summary":"Report preview availability","description":"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.","operationId":"get_report_preview_info_api_v1_reports_preview_info_get","parameters":[{"name":"s3_key","in":"query","required":true,"schema":{"type":"string","title":"S3 Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ReportPreviewInfoResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ReportPreviewInfoResponse":{"properties":{"available":{"type":"boolean","title":"Available"},"page_count":{"type":"integer","title":"Page Count"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["available","page_count"],"title":"ReportPreviewInfoResponse","description":"Availability + page count for a server-rendered PNG preview.\n\n``reason`` is only populated when ``available`` is ``False``: one of\n``renderer_unavailable`` (no soffice binary configured/found),\n``unsupported_type`` (not a pdf/pptx/xlsx/xlsm), or ``render_failed``\n(source fetch or conversion/rasterisation failed)."},"SuccessEnvelope_ReportPreviewInfoResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/ReportPreviewInfoResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ReportPreviewInfoResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}