Streams conversations from the current organization as CSV or JSON, including flattened message content for each conversation. The `format` query parameter defaults to `json`, and `redact_pii` defaults to `false`. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `export: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. `format` defaults to JSON. CSV is returned as `text/csv`; JSON is streamed as an array. `date_from` and `date_to` are optional independent ISO 8601 boundaries, and `redact_pii=true` masks recognized emails and phone numbers in exported message text. The response includes `Content-Disposition` and should be streamed to storage rather than buffered for large organizations. Exports exceeding the configured row limit fail before streaming begins. Retry behavior: This read-only operation is safe to retry.
/api/export/conversationsOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
[
{
"id": "11111111-1111-4111-8111-111111111111",
"status": "open",
"visitorId": "22222222-2222-4222-8222-222222222222",
"createdAt": "2026-07-15T10:00:00.000Z",
"updatedAt": "2026-07-15T10:30:00.000Z",
"messageCount": 1,
"messages": "[visitor] I need a copy of my invoice"
}
]{
"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"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}curl --request GET \
'https://api.convor.io/api/export/conversations?format=csv' \
--header 'Accept: text/csv' \
--header 'Authorization: Bearer convor_sk_...'const response = await fetch("https://api.convor.io/api/export/conversations?format=csv", {
method: "GET",
headers: {
"Accept": "text/csv",
"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?
Export analytics summary as CSV
Exports organization-level analytics as a CSV file. The format is always CSV, and when no date range is provided the report covers the last 30 days. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `export: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. Always returns a `text/csv` attachment. When omitted, the date window defaults to the previous 30 days ending at request time; explicit `date_from` and `date_to` are interpreted as ISO 8601 instants. Retry behavior: This read-only operation is safe to retry.
Export full conversation archive as JSON (with messages)
Streams a full JSON archive of conversations and their messages for the current organization. The archive always returns JSON, respects the date range filters, and can optionally redact message PII. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `export: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. Always returns a streamed `application/json` attachment containing conversations, visitor data, metadata, and all included messages. Date boundaries are optional, and `redact_pii=true` masks recognized PII in message content. The response is a potentially large archive; stream it to disk or object storage and honor `Content-Disposition` rather than parsing it as a small API page. Retry behavior: This read-only operation is safe to retry.