v1

latestSwagger 2.02026-07-175658186.8 KB

Segments

Create a segment

post/{globalCompanyId}/segments

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

Query parameters

localestring

Locale. Valid values include 'en_US', 'fr_FR', 'ja_JP', 'de_DE', 'es_ES', 'ko_KR', 'pt_BR', 'zh_CN', and 'zh_TW'.

expansionstring[]

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

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.

Request body

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

Response

successful operation

idstring

Id of the segment.