Get segment
Changed onRetrieves 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.
Request
- Base URLhttps://apiexamples.vtexcommercestable.com.br
- URLhttps://apiexamples.vtexcommercestable.com.br/api/segments
- AuthAPI key in cookie vtex_session and API key in cookie vtex_segment
Response
OK
Changes
- breaking
the response property
became nullable for the status - breaking
the response property
became nullable for the status - breaking
the response property
became nullable for the status - breaking
the response property
became nullable for the status
- breaking
- breaking
the response property
became nullable for the status
- breaking