Retrieve a segment by ID.

curl --request GET \
  --url https://api.topsort.com/public/v1/segment-service/segments/{segment-id} \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "description": "<string>",
  "id": "<string>",
  "total": 123
}

GET

public

segment-service

segments

{segment-id}

Retrieve a segment by ID.

curl --request GET \
  --url https://api.topsort.com/public/v1/segment-service/segments/{segment-id} \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "description": "<string>",
  "id": "<string>",
  "total": 123
}

Authorization

string

header

requis

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

segment-id

string

requis

The external ID of the segment.

Successful Response

name

string

requis

Name of the segment.

Maximum string length: 64

description

string | null

requis

Description of the segment.

Maximum string length: 400

string

requis

ID of the segment.

total

integer

requis

User count of the segment.

⌘I