Segments API

Retrieve paginated segments

Changed on

A segment response includes 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>: Whether or not the segment is 'Deleted' (note that deleted segments are only returned if requested by ID)

get/segments

Request

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

Query parameters

expansionstring[]

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

includeTypestring[]

Include additional segments not owned by user.

dataIdsstring

Filter list to only include segments tied to the specified data group ID list (comma-delimited)

ownerIdstring

Filter list to only include segments owned by the specified imsUserId

filterByIdsstring

Filter list to only include segments in the specified list (comma-delimited list of IDs). This has filtered Ids from tags, approved, favorites and user specified Ids list.

toBeUsedInRsidstring

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

localestring

Locale

namestring

Filter list to only include segments that contains the Name

filterByModifiedAfterstring

Filter list to only include segments modified since this date (ISO8601 format)

cachedtrue | false

return cached results

pagination'true' | 'false'

Return paginated results

limitinteger

Number of results per page

pageinteger

Page number (base 0 - first page is "0")

sortDirectionstring

Sort direction (ASC or DESC

sortPropertystring

Property to sort by (name, modified_date, performanceScore, id is currently allowed)

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

object required

Changes