getSegmentMembers
GET {{baseUrl}}/ssot/segments/:segmentApiName/members?fields=[]&filters=<string>&limit=<integer>&offset=<integer>&orderBy=<string>
Get segment members in Data Cloud.
Available Version: 58.0
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
fields | string | Comma-separated list of up to 50 field names that you want to include in the result, for example, Id__c,FirstName__c,GenderId__c,Occupation__c . If unspecified, Id__c is returned. |
Available Version: 58.0
|
| filters
| string | | Filter the result set to a more narrow scope or specific type, such as [GenderId__c=Male,FirstName__c=Angel]
.
Available Version: 58.0
|
| limit
| string | | Maximum number of rows to return from 1
–1000
. If unspecified, the default number of rows is 100
.
Available Version: 58.0
|
| offset
| string | | Number of rows to skip before returning results. If unspecified, no rows are skipped.
Available Version: 58.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: 58.0 |
RESPONSES
status: OK
{"data":[{"deltaType":"\u003cstring\u003e","id":"\u003cstring\u003e","kqId":"\u003cstring\u003e","snapshotType":"\u003cstring\u003e","timestamp":"\u003cstring\u003e","versionStamp":"\u003cstring\u003e"},{"deltaType":"\u003cstring\u003e","id":"\u003cstring\u003e","kqId":"\u003cstring\u003e","snapshotType":"\u003cstring\u003e","timestamp":"\u003cstring\u003e","versionStamp":"\u003cstring\u003e"}],"endTime":"\u003cstring\u003e","filter":"\u003cstring\u003e","limit":"\u003cinteger\u003e","nextPageUrl":"\u003cstring\u003e","offSet":"\u003cinteger\u003e","orderBy":"\u003cstring\u003e","rowCount":"\u003cinteger\u003e","startTime":"\u003cstring\u003e","totalCount":"\u003cinteger\u003e"}