Data export in CSV and JSON formats
Data export in CSV and JSON formats
POST Bulk export conversations with filters — Streams conversations with filters as CSV or JSON, including operator names and flattened message content.GET 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.GET Export conversations with messages — Streams conversations from the current organization as CSV or JSON, including flattened message content for each conversation.GET Export full conversation archive as JSON (with messages) — Streams a full JSON archive of conversations and their messages for the current organization.GET Export visitor list as CSV — 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.Was this page helpful?
Search messages within a conversation
Searches messages inside one conversation in the current organization. The conversation must belong to the current organization before messages are searched. Results are ordered by text relevance and then by the newest matching message. Pagination defaults to page 1 with 50 items per page, and the maximum page size is 100. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `search: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. `conversation_id` is required and must identify a conversation in the authenticated organization. Pagination defaults to page 1 and 50 items, with a maximum page size of 100. Retry behavior: This read-only operation is safe to retry.
Bulk export conversations with filters
Streams conversations with filters as CSV or JSON, including operator names and flattened message content. `format` defaults to `csv`, `redact_pii` defaults to `false`, and omitted `status`, `operatorId`, `tags`, `dateFrom`, or `dateTo` leave that filter unset. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `export:write` 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. Streams filtered conversations as CSV or JSON. `format` defaults to CSV; status, operator, tag, and date filters are optional. `redact_pii=true` masks recognized emails and phone numbers in message text. The export is audited after streaming. After a connection failure, do not automatically repeat a large export without checking whether the client already received a complete attachment. Retry behavior: This operation is not idempotent. After an ambiguous timeout, read the resource state before retrying to avoid duplicate work, messages, files, bookings, exports, or events.