getSegments
GET {{baseUrl}}/ssot/segments?batchSize=<integer>&dataspace=<string>&offset=<integer>&orderby=<string>
Get segments in Data Cloud.
Available Version: 55.0
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
batchSize | string | Number of items to return. Values are from 1–200. If unspecified, the default value is 20 |
Available Version: 56.0
|
| dataspace | string | | Name of the dataspace in which to perform the action. User must have permission to this dataspace. Valid when bulk-listing segments. If unspecified, default is the default dataspace.
Available Version: 58.0
|
| offset | string | | Number of rows to skip before returning results. If unspecified, no rows are skipped.
Available Version: 56.0
|
| orderby | string | | Sort order for the result set, such as Name ASC or MarketSegmentType DESC. If unspecified, items are returned by ID in ascending order.
Available Version: 56.0 |
RESPONSES
status: OK
{"batchSize":"\u003cinteger\u003e","offset":"\u003cinteger\u003e","orderByExpression":"\u003cstring\u003e","segments":[{"apiName":"\u003cstring\u003e","dataSpace":"\u003cstring\u003e","description":"\u003cstring\u003e","developerName":"\u003cstring\u003e","displayName":"\u003cstring\u003e","excludeCriteria":"\u003cstring\u003e","includeCriteria":"\u003cstring\u003e","includeDbt":{"models":[{"name":"\u003cstring\u003e","sql":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","sql":"\u003cstring\u003e"}]},"lookalikeCriteria":{"additionalPopulation":"\u003cint64\u003e","seedSegmentId":"\u003cstring\u003e"},"marketSegmentDefinitionId":"\u003cstring\u003e","marketSegmentId":"\u003cstring\u003e","nextPublishDateTime":"\u003cstring\u003e","publishInterval":"\u003cstring\u003e","publishScheduleEndDate":"\u003cstring\u003e","publishScheduleStartDateTime":"\u003cstring\u003e","publishStatus":"\u003cstring\u003e","segmentMembershipDmo":{"historyTable":"\u003cstring\u003e","latestTable":"\u003cstring\u003e","profileTable":"\u003cstring\u003e"},"segmentMembershipTable":"\u003cstring\u003e","segmentOnApiName":"\u003cstring\u003e","segmentOnId":"\u003cstring\u003e","segmentStatus":"\u003cstring\u003e","segmentType":"\u003cstring\u003e"},{"apiName":"\u003cstring\u003e","dataSpace":"\u003cstring\u003e","description":"\u003cstring\u003e","developerName":"\u003cstring\u003e","displayName":"\u003cstring\u003e","excludeCriteria":"\u003cstring\u003e","includeCriteria":"\u003cstring\u003e","includeDbt":{"models":[{"name":"\u003cstring\u003e","sql":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","sql":"\u003cstring\u003e"}]},"lookalikeCriteria":{"additionalPopulation":"\u003cint64\u003e","seedSegmentId":"\u003cstring\u003e"},"marketSegmentDefinitionId":"\u003cstring\u003e","marketSegmentId":"\u003cstring\u003e","nextPublishDateTime":"\u003cstring\u003e","publishInterval":"\u003cstring\u003e","publishScheduleEndDate":"\u003cstring\u003e","publishScheduleStartDateTime":"\u003cstring\u003e","publishStatus":"\u003cstring\u003e","segmentMembershipDmo":{"historyTable":"\u003cstring\u003e","latestTable":"\u003cstring\u003e","profileTable":"\u003cstring\u003e"},"segmentMembershipTable":"\u003cstring\u003e","segmentOnApiName":"\u003cstring\u003e","segmentOnId":"\u003cstring\u003e","segmentStatus":"\u003cstring\u003e","segmentType":"\u003cstring\u003e"}]}