v1

latestOpenAPI 3.0.02026-07-2484509641.9 KB
Audiences

List Rows

Retrieves rows from an audience with support for filtering, sorting, and pagination. Rows are individual contact or company records; each row contains cells keyed by columnId, where each cell reports its value and a CellStateRESULT (value present), BLANK (no value set), LOADING (enrichment in progress), ERROR (enrichment failed for this cell), or NO_RESULT (enrichment returned no match). Provide a flat filters array in the request body to narrow results by column values and conditions. Use page[number] and page[size] (default 25, max 100) to paginate through results. Use the sort query parameter with a columnId value and a - prefix for descending order. Use the columns query parameter to limit which columns are returned per row. Returns 200 with a paginated array of rows and navigation links. Returns 400 if filter criteria are malformed or column references are invalid.

post/studio/v1/audiences/{audienceId}/rows/actions/search

Path parameters

audienceIdstring uuid required

The unique identifier for the audience

Query parameters

page[number]integer

Page number for the results.

page[size]integer

Number of records to return per page. Default is 25.

sortstring

ColumnId based on which to sort the results. Use '-' prefix for descending order.

columnsstring[]

List of column IDs to include in the response, If provided, only these columns will be returned for each row.

Response

Success