VTEX Segment API

openapi: 3.2.0
info:
  title: VTex Session Manager Segment API
  description: 'Session Manager tracks the current browsing sessions of all customers on the VTEX platform. Important session information is automatically captured and stored in a secure and easily accessible location. This includes data such as relevant cookies, query strings, authentication credentials, current profile and pricing information, if applicable. Session Manager API allows developers to retrieve and manage information about sessions. No authentication is required.


    For more information, read the [Session Manager guide](https://developers.vtex.com/docs/guides/session-manager).


    ## Index


    ### Sessions


    - `POST` [Create new session](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions)

    - `GET` [Get session](https://developers.vtex.com/docs/api-reference/session-manager-api#get-/api/sessions)

    - `PATCH` [Edit session](https://developers.vtex.com/docs/api-reference/session-manager-api#patch-/api/sessions)


    ### Segment


    - `GET` [Get segment](https://developers.vtex.com/docs/api-reference/session-manager-api#get-/api/segments)'
  contact: {}
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
tags:
- name: Segment
  description: ''
paths:
  /api/segments:
    get:
      tags:
      - Segment
      summary: VTex Get segment
      description: '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](https://developers.vtex.com/docs/api-reference/session-manager-api#patch-/api/sessions) endpoint. ## Permissions


        This endpoint does not require [authentication](https://developers.vtex.com/docs/guides/authentication) or [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).'
      operationId: GetSegment
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Segment'
              example:
                campaigns: null
                channel: '1'
                priceTables: null
                regionId: v2.1BB18CE648B5111D0933734ED83EC783
                utm_campaign: null
                utm_source: null
                utmi_campaign: null
                currencyCode: BRL
                currencySymbol: R$
                countryCode: BRA
                cultureInfo: en-US
                channelPrivacy: public
      security:
      - vtex_session: []
        vtex_segment: []
      deprecated: false
components:
  schemas:
    Segment:
      type: object
      description: Object containing information about the segment.
      properties:
        campaigns:
          type: string
          description: Campaigns associated with the session.
        channel:
          type: string
          description: '[Trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID.'
        priceTables:
          type: string
          description: Price tables associated with the session.
        regionId:
          type: string
          description: ID of the session's region.
        utm_campaign:
          type: string
          description: UTM campaign code.
        utm_source:
          type: string
          description: UTM source code.
        utmi_campaign:
          type: string
          description: UTMI campaign code.
        currencyCode:
          type: string
          description: Currency code.
        currencySymbol:
          type: string
          description: Currency symbol.
        countryCode:
          type: string
          description: Country code.
        cultureInfo:
          type: string
          description: Locale that provides culture-specific information, such as the language, sublanguage, country/region, calendar, and conventions associated with a particular culture. Read [this documentation](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo?view=net-7.0#culture-names-and-identifiers) for more details.
        channelPrivacy:
          type: string
          description: Defines whether or not the channel is private.
      example:
        campaigns: null
        channel: '1'
        priceTables: null
        regionId: v2.1BB18CE648B5111D0933734ED83EC783
        utm_campaign: null
        utm_source: null
        utmi_campaign: null
        currencyCode: BRL
        currencySymbol: R$
        countryCode: BRA
        cultureInfo: pt-BR
        channelPrivacy: public
  securitySchemes:
    vtex_session:
      type: apiKey
      in: cookie
      name: vtex_session
      description: Token that identifies the user's individual session. Obtained [when a new session is created](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions).
    vtex_segment:
      type: apiKey
      in: cookie
      name: vtex_segment
      description: Token that identifies the user's segment, shared with other users with similar navigation parameters. Obtained [when a new session is created](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions).