cdp
segment

List all segments

Changed on
get/cdp/{connection_id}/segment

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/cdp/{connection_id}/segment
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this segment object

created_atstring date-time

The date that this segment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this segment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The name of the segment/audience

slugstring

The data-plane handle/key used to identify segment membership in profiles and destinations

descriptionstring

The description of the segment/audience

definitionstring

The membership rule/query that defines the segment

type'USERS' | 'ACCOUNTS' | 'LINKED'

The type of entity the segment targets (USERS, ACCOUNTS, LINKED)

compute_mode'REALTIME' | 'BATCH'

How the segment membership is computed (REALTIME or BATCH)

sizenumber

The number of profiles currently in the segment

is_activeboolean

Whether the segment is active/enabled

source_idstring

The cdp_source this segment originated from; points to CdpSource

rawobject

The raw data returned by the integration for this segment

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status