Polls one asynchronous analytics PDF export. A running job returns `202`; a completed job returns the PDF attachment with `200`; an unknown job returns `404`; a failed job returns `500` with its queue error. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `analytics:read` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. Running states are `waiting`, `active`, or `delayed`. Poll with backoff and stop after `200`, `404`, or `500`. Job identifiers are opaque queue IDs and must not be parsed. Retry behavior: This read-only operation is safe to retry.
/api/analytics/export/{jobId}/statusOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/pdf
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
"<binary PDF data>"{
"state": "active",
"jobId": "12345"
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"state": "failed",
"error": "PDF renderer unavailable"
}curl --request GET \
'https://api.convor.io/api/analytics/export/exp_01J2B3C4D5E6F7G8H9J0K1M2N3/status' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'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?
Get visitor sources by UTM parameters
Returns UTM source, medium, and campaign breakdowns for the selected date range. Only visitors with UTM metadata are included, and the response is limited to the top 20 rows. Use `format=csv` to export the same breakdown. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `analytics:read` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. The `range` preset defaults to `30d`. To use a custom range, supply both `start` and `end` as ISO 8601 datetimes with offsets; supplying only one boundary is rejected. Explicit boundaries override the preset. Date buckets and comparisons are evaluated as absolute instants and aggregated in UTC. Empty periods return the route's documented zero or empty collection shape rather than data from another organization. Where the route exposes `format=csv`, CSV is a downloadable `text/csv` response and may require a plan with analytics export access; JSON remains the default. Retry behavior: This read-only operation is safe to retry.
Real-time team workload and capacity saturation (#740)
Returns real-time workload and capacity data for operators in the current organization. `scope` defaults to `all`; use `active` to limit the result to operators whose status is `online` or `away`. `threshold` defaults to `0.8`, which means the team is marked as saturated at 80% of its calculated capacity. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `analytics:read` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. The optional `threshold` is a ratio from 0 to 1 and `scope` selects the workload population without changing organization isolation. Omitted values use the route defaults shown in the parameter schemas. Retry behavior: This read-only operation is safe to retry.