Exports visitors for the current organization as a CSV file. The format is fixed to CSV, and the export is streamed in batches for large visitor lists. 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 `text/csv` attachment for visitors in the authenticated organization. The route enforces the configured maximum export row count before writing the response body. Retry behavior: This read-only operation is safe to retry.
/api/export/visitorsOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
text/csv
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
"id,identifier,fingerprint,firstSeenAt,lastSeenAt,totalSessions,geoCountry,geoCity\n22222222-2222-4222-8222-222222222222,[email protected],,2026-07-01T10:00:00.000Z,2026-07-15T10:00:00.000Z,3,PL,Warsaw"{
"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/visitors?format=csv' \
--header 'Accept: text/csv' \
--header 'Authorization: Bearer convor_sk_...'const response = await fetch("https://api.convor.io/api/export/visitors?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 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.
GDPR
GDPR data management