👨‍💻 API Reference 📣 Release Notes 📺 Request a Demo

Segments REST API Guide

PreviousCustom Metrics REST API Guide NextBaselines REST API Guide

Last updated 1 month ago

Was this helpful?

Detail info of a segment

get

Detail info of a segment

Authorizations

Path parameters

uuidstring · uuidRequired

uuid path parameter

Responses

application/json

all ofOptional

Response object for standard API responses.

application/json

get

GET /v3/segments/{uuid} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "definition": "text",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "model": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "created_at": "2025-04-23T07:35:09.782Z",
    "updated_at": "2025-04-23T07:35:09.782Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    }
  }
}

Delete segment by uuid

delete

Delete segment by uuid

Authorizations

Path parameters

uuidstring · uuidRequired

uuid path parameter

Responses

application/json

delete

DELETE /v3/segments/{uuid} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List all segments for a model

get

List all segments for a model

Authorizations

Path parameters

model_idstring · uuidRequired

model id path parameter

Query parameters

filterstringOptional

Allows you to filter by any field.

searchstringOptional

Allows you to search by any field.

orderingstringOptional

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitintegerOptional

Limit for the pagination

offsetintegerOptional

Offset for the pagination

Responses

application/json

all ofOptional

Response object for paginated API responses.

application/json

get

GET /v3/models/{model_id}/segments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": "2.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "definition": "text",
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "created_at": "2025-04-23T07:35:09.782Z",
        "updated_at": "2025-04-23T07:35:09.782Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "name@gmail.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "name@gmail.com"
        }
      }
    ]
  }
}

List all segments

get

List all segments

Authorizations

Query parameters

filterstringOptional

Allows you to filter by any field.

searchstringOptional

Allows you to search by any field.

orderingstringOptional

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitintegerOptional

Limit for the pagination

offsetintegerOptional

Offset for the pagination

Responses

application/json

all ofOptional

Response object for paginated API responses.

application/json

get

GET /v3/segments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": "2.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "definition": "text",
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "created_at": "2025-04-23T07:35:09.782Z",
        "updated_at": "2025-04-23T07:35:09.782Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "name@gmail.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "name@gmail.com"
        }
      }
    ]
  }
}

Create new segment

post

Create new segment

Authorizations

Body

all ofOptional

Responses

application/json

all ofOptional

Response object for standard API responses.

application/json

post

POST /v3/segments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "model_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "definition": "text"
}

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "definition": "text",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "model": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "created_at": "2025-04-23T07:35:09.782Z",
    "updated_at": "2025-04-23T07:35:09.782Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    }
  }
}