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.

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?

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?

Export analytics summary as CSV

Request examples

curl

JavaScript

On this page

Export analytics summary as CSV

Request examples

curl

JavaScript

On this page

Authorization

Query Parameters

Response Body

`text/csv`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Export analytics summary as CSV

On this page

Export analytics summary as CSV

On this page

200text/csv

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`text/csv`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`