Segments (REST API)

GET Retrieve information about a specific marketing segment.

GET /services/data/{apiVersion}/sobjects/MarketSegment/{segmentId}

Operation ID: getSegment.

Parameters

segmentId (query, string, required) The record ID of the segment.

Responses

200 This response indicates that the API accepted your request to retrieve information about the specified segment.

Media type: application/json. Schema: getSegmentResponseBody.

Example

{
  "attributes": {
    "type": "MarketSegment",
    "url": "/services/data/{apiVersion}/sobjects/MarketSegment/1sgSB0000007SNlYAM"
  },
  "Id": "1sgSB0000007SNlYAM",
  "IsDeleted": false,
  "Name": "TestSegment",
  "CreatedDate": "2023-12-28T19:00:31.000+0000",
  "CreatedById": "005SB0000029wwTYAQ",
  "LastModifiedDate": "2023-12-28T19:02:52.000+0000",
  "LastModifiedById": "005SB0000029x8fYAA",
  "SystemModstamp": "2023-12-28T19:02:52.000+0000",
  "LastViewedDate": "2023-12-28T19:04:05.000+0000",
  "LastReferencedDate": "2023-12-28T19:04:05.000+0000",
  "Description": null,
  "IncludeCriteria": "{\"type\":\"TextComparison\",\"path\":null,\"joinPath\":null,\"subject\":{\"objectApiName\":\"ssot__Contact__dlm\",\"fieldApiName\":\"ssot__Gender__c\"},\"selfReference\":false,\"operator\":\"equal\",\"values\":[\"Male\"]}",
  "ExcludeCriteria": null,
  "PublishScheduleInterval": "12",
  "PublishScheduleStartDateTime": "2023-12-28T20:30:00.000+0000",
  "PublishScheduleEndDate": "2024-12-28",
  "LastPublishedEndDateTime": null,
  "NextPublishDateTime": null,
  "SegmentStatus": "ACTIVE",
  "LastSegmentStatusDateTime": "2023-12-28T19:02:51.000+0000",
  "LastSegmentStatusErrorCode": null,
  "LastSegmentMemberCount": 434,
  "LastSegmentRemainderCount": 566,
  "LastSegmentExcludedCount": 0,
  "PublishStatus": null,
  "LastPublishStatusDateTime": null,
  "LastPublishStatusErrorCode": null,
  "LastSegmentStatusErrorDetails": null,
  "DataSpaceId": "0vhSB0000002z2bYAA",
  "SegmentMembershipDataModelList": null,
  "MarketSegmentType": "UI",
  "SeedModelStatus": "INACTIVE",
  "LastSeedModelStatusDateTime": null,
  "LastSeedModelStatusErrorCode": null,
  "LastSeedModelRunDateTime": null,
  "LastSegmentTotalCount": 1000,
  "LastSegmentIncludedCount": 434,
  "PublishType": "STANDARD",
  "SegmentMembershipTable": null,
  "IsSeedSegment": false,
  "SeedSimilarityHighToMedium": null,
  "SeedSimilarityMediumToLow": null,
  "SeedSimilarity": null,
  "LastSegmentCountEndDateTime": "2023-12-28T19:02:52.000+0000"
}

401 This response indicates that the API wasn’t able to authorize your request. When you receive a 401 response, verify that you've obtained an authorization token and that the token is still valid.
Media type: application/json. Schema: httpErrorResponseBody.

Example
```
[
  {
    "message": "Session expired or invalid",
    "errorCode": "INVALID_SESSION_ID"
  }
]
```
404 This response indicates that the URI in your request couldn’t be reached. When you receive a 404 response, verify that your request included the correct record ID for the segment.
Media type: application/json. Schema: httpErrorResponseBody.

Example
```
[
  {
    "errorCode": "NOT_FOUND",
    "message": "The requested resource does not exist"
  }
]
```