Get a segment by ID.

Retrieve a single segment by its ID.

GET https://{tenantDomain}/api/v2/experimentation/segments/{id}

Get a segment by ID.

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/experimentation/segments/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "name": "<string>",
  "rules": [
    {
      "match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      },
      "not_match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

The ID of the segment to retrieve.

Réponse

200

application/json

Segment successfully retrieved.

id · string · requis

Pattern: ^seg_[A-HJ-NP-Za-km-z1-9]+$

name · string · requis

type · enum<string> · requis

Options disponibles: self, auth0

rules · object[] · requis

Show child attributes

created_at · string<date-time> · requis

updated_at · string<date-time> · requis

description · string