Skip to content
Convor
Convor Docs
API ReferenceExport

Export full conversation archive as JSON (with messages)

Streams a full JSON archive of conversations and messages for the active site or authorized All-sites scope.

GET/api/export/conversations/archive

Streams a full JSON archive of conversations and messages for the active site or authorized All-sites scope. The archive includes project attribution, respects date filters, and can redact message PII. The attachment includes conversations, visitor data, metadata, and messages. Date boundaries are optional, and redact_pii=true masks recognized PII in message content. Archives can be large. Stream the response to disk or object storage and honor Content-Disposition.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
export: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.

Query Parameters

scope?"all"

Query parameter. Scope. Allowed values: all.

Value in

  • "all"
format?string

Query parameter. Format. Allowed values: csv, json.

Default"json"

Value in

  • "csv"
  • "json"
date_from?string

Query parameter. ISO 8601 date and time for date_from.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
date_to?string

Query parameter. ISO 8601 date and time for date_to.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
redact_pii?boolean

Query parameter. Whether to mask recognized personal data in exported text.

Defaultfalse

Header Parameters

X-Project-Id?|

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/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

"example"

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/export/conversations/archive?format=json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/export/conversations/archive?format=json", {
  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?

Export conversations with messages

Streams conversations from the active site or authorized All-sites scope as CSV or JSON, including project attribution and flattened message content.

Export visitor list as CSV

Exports visitors for the active site or authorized All-sites scope as CSV, including project attribution.

On this page

Request examplescurlJavaScript