v1

latestOpenAPI 3.0.02026-07-144431.2 KB
Segment

Get segment

Retrieves information about the segment, which contains additional data related to the session's context.

You can add certain public fields as the query string and the system will attempt to fulfill it. Values such as cultureInfo and utm are overwriteable, just keep in mind such changes will not be reflected in the client's session.

If you wish to change the value on the session (and thus be reflected on the segment without special query strings), then use the Edit session endpoint.

Permissions

This endpoint does not require authentication or permissions.

get/api/segments

Response

OK

campaignsstring nullable

Campaigns associated with the session.

channelstring
priceTablesstring nullable

Price tables associated with the session.

regionIdstring

ID of the session's region.

utm_campaignstring nullable

UTM campaign code.

utm_sourcestring nullable

UTM source code.

utmi_campaignstring nullable

UTMI campaign code.

currencyCodestring

Currency code.

currencySymbolstring

Currency symbol.

countryCodestring

Country code.

cultureInfostring

Locale that provides culture-specific information, such as the language, sublanguage, country/region, calendar, and conventions associated with a particular culture. Read this documentation for more details.

channelPrivacystring

Defines whether or not the channel is private.