v1

latestSwagger 2.02026-07-175658186.8 KB
Segments

Retrieve all segments

get/{globalCompanyId}/segments

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

Query parameters

rsidsstring

Filter list to only include segments tied to specified RSID list (comma-delimited)

segmentFilterstring

Filter list to only include segments in the specified list (comma-delimited list of IDs)

localestring

Locale

namestring

Filter list to only include segments that contains the Name

tagNamesstring

Filter list to only include segments that contains one of the tags

filterByPublishedSegments'all' | 'true' | 'false'

Filter list to only include segments where the published field is set to one of the allowable values (all, true, false).

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, id is currently allowed)

expansionstring[]

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

includeTypestring[]

Include additional segments not owned by user. The "all" option takes precedence over "shared"

Headers

Authorizationstring required

The access token copied from your AA API client integration, prefixed with "Bearer ".

x-api-keystring required

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

Response

successful operation

idstring

Id of the segment.

namestring

A name for the segment.

descriptionstring

A description of the segment.

rsidstring

The report suite id.

reportSuiteNamestring

The friendly name for the report suite id.

definitionLastModifiedstring date-time
categoriesstring[]
siteTitlestring

A name for the report suite. This is deprecated and should use the report suite name instead.

modifiedstring date-time
createdstring date-time