Skip to content
Convor
Convor Docs
API ReferenceExport

Export analytics summary as CSV

Exports analytics for the active site or authorized All-sites scope as CSV.

GET/api/export/analytics

Exports analytics for the active site or authorized All-sites scope as CSV. The format is always CSV, and when no date range is provided the report covers the last 30 days. date_from and date_to use ISO 8601 instants. Without them, the report covers the previous 30 days ending at request time.

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?"csv"

Query parameter. Format. Allowed values: csv.

Default"csv"

Value in

  • "csv"
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

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

"example"

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/export/analytics?format=csv' \
  --header 'Accept: text/csv' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/export/analytics?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?

Bulk export conversations with filters

Streams conversations with filters as CSV or JSON, including operator names and flattened message content.

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.

On this page

Request examplescurlJavaScript