ackDB

Export segment results as CSV

Exports a saved Segment as a CSV download, resolving rows the same way as GET /observe/segments/{id}/results: the segment's HOME grain by default, a cross-grain pivot when grain is the other grain, or a DERIVED segment's own grain. The optional extraFilter / columns / sort params are pivot/derived-only (400 on the home grain), exactly as on /results. limit/offset do not apply - the whole matched set is paged server-side and capped at 10,000 rows (over → 400). Cell values are RAW; headers use catalog display labels with a leading identity column (entityId/contactId).

get/api/v1/ackdb/observe/segments/{id}/export

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

idstring required

Query parameters

grain'company' | 'contact' | 'person'

Render grain. Omit for the segment's home grain; set to another grain to pivot.

extraFilterstring

URL-encoded JSON FilterGroup 'filter on top' (pivot/derived only; 400 on the home grain).

columnsstring

URL-encoded JSON SegmentColumn[] projection override (cross-grain pivot only).

sortstring

URL-encoded JSON SegmentSort[] transient sort override (pivot/derived only; 400 on the home grain) - keeps the CSV row order matching a header-sorted pivot view.

Response

A CSV document (UTF-8 with BOM, CRLF line endings).

Changes

No recorded changes to this operation across all 1 revision of this API.