Poll the status of an async analytics PDF export
Polls one asynchronous analytics PDF export.
/api/analytics/export/{jobId}/statusPolls one asynchronous analytics PDF export. A running export returns 202; a completed export returns the PDF attachment with 200; an unknown export returns 404; a failed export returns 500 with its customer-safe failure message. Running states are waiting, active, or delayed. Poll with backoff and stop after 200, 404, or 500. Job identifiers are opaque tokens and must not be parsed.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
analytics:read- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.
Path Parameters
Path parameter. Unique identifier of the related job.
1 <= lengthQuery Parameters
Query parameter. Scope. Allowed values: all.
Value in
- "all"
Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Response Body
application/pdf
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
"<binary PDF data>"Request examples
curl
curl --request GET \
'https://api.convor.io/api/analytics/export/exp_01J2B3C4D5E6F7G8H9J0K1M2N3/status' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/analytics/export/exp_01J2B3C4D5E6F7G8H9J0K1M2N3/status", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?