Segments API

Retrieve a segment by ID

A segment response will always include these default items:<br><b>ID</b><br><br>Other attributes can be optionally requested through the 'expansion' field: <br><b>name</b>: Name of the segment<br><b>description</b>: Description of the segment<br><b>dataId</b>: Associated data ID of the segment<br><b>owner</b>: Owner of the segment<br><b>modified</b>: Date that the segment was last modified (ISO 8601)<br><b>definition</b>: Segment definition as JSON object<br><b>compatibility</b>: Products that the segment is compatible with<br><b>isDeleted</b>: Returns whether or not the segment is 'Deleted' (note that deleted segments are only returned if requested by ID)

get/segments/{id}

Request

  • Base URL: https://cja.adobe.io
  • URL: https://cja.adobe.io/segments/{id}
  • Auth: none declared. Required headers: Authorization, x-api-key, x-gw-ims-org-id

Path parameters

idstring required

The segment ID to retrieve

Query parameters

toBeUsedInRsidstring

The dataview ID for which the segment is intended to be used. This dataview is used to determine compatibility and permissions

localestring

Locale

expansionstring[]

Comma-delimited list of additional segment metadata fields to include on response.

Headers

Authorizationstring required

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-keystring required

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-idstring required

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Response

Successful operation

namestring
descriptionstring
modifiedstring date-time
report_suitestring
modifiedByIdstring
definitionobject
compatibilityobject
createDatestring date-time
createdBystring
disabledboolean
internalboolean
organizationstring
templateboolean
recentRecordedAccessstring date-time
performanceScorestring
performanceScoreWeightVersionstring
idstring
definitionLastModifiedstring date-time
dataIdstring
isDeletedboolean
dataNamestring
tagsobject[]
sharesobject[]
approvedboolean
favoriteboolean
usageSummaryobject

Changes

No recorded changes to this operation across all 30 revisions of this API.