Export analytics data as CSV, JSON or PDF
Creates an organization analytics export for selected metric sections.
/api/analytics/exportCreates an organization analytics export for selected metric sections. JSON and CSV are produced synchronously with 200; PDF is queued and returns 202 with a job identifier and polling URL. range defaults to 30d. A custom interval requires both dateFrom and dateTo; those boundaries override range and are applied to the export queries. CSV and PDF require analytics export plan access. A repeated PDF request creates another export, so retain the returned jobId and poll it instead of retrying after an ambiguous success.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
analytics:write- 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
- Non-idempotent: Repeating this request may create duplicate work or side effects. After an ambiguous timeout, check the resource state before retrying.
Query 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).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "conversations": [ { "date": "2026-07-15", "conversations": 42, "resolved": 31 } ], "operators": [ { "operatorId": "33333333-3333-4333-8333-333333333333", "name": "Jane Smith", "handled": 18 } ]}Request examples
curl
curl --request POST \
'https://api.convor.io/api/analytics/export' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"format": "json",
"dateFrom": "2026-07-01T00:00:00.000Z",
"dateTo": "2026-07-31T23:59:59.000Z",
"range": "30d",
"metrics": [
"conversations",
"operators"
]
}'JavaScript
const response = await fetch("https://api.convor.io/api/analytics/export", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"format": "json",
"dateFrom": "2026-07-01T00:00:00.000Z",
"dateTo": "2026-07-31T23:59:59.000Z",
"range": "30d",
"metrics": [
"conversations",
"operators"
]
}),
});
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?