Segments REST API Guide | Fiddler AI

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

List all segments

get

/v3/segments

Authorizations

Query parameters

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

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

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/segments' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

500

{
  "api_version": "3.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-03-10T05:25:53.889Z",
        "updated_at": "2025-03-10T05:25:53.889Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        }
      }
    ]
  }
}

List of all segments

Create new segment

post

/v3/segments

Authorizations

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/segments' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "model_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "definition": "text"
  }'

200

400

401

403

404

500

{
  "api_version": "3.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-03-10T05:25:53.889Z",
    "updated_at": "2025-03-10T05:25:53.889Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    }
  }
}

Segment successfully created

Detail info of a segment

get

/v3/segments/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

uuid path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/segments/{uuid}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

403

404

500

{
  "api_version": "3.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-03-10T05:25:53.889Z",
    "updated_at": "2025-03-10T05:25:53.889Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    }
  }
}

Get detail info

Delete segment by uuid

delete

/v3/segments/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

uuid path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v3/segments/{uuid}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

500

No body

Success

List all segments for a model

get

/v3/models/{model_id}/segments

Authorizations

Path parameters

model_idstring · uuidrequired

model id path parameter

Query parameters

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

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

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/models/{model_id}/segments' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

500

{
  "api_version": "3.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-03-10T05:25:53.889Z",
        "updated_at": "2025-03-10T05:25:53.889Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        }
      }
    ]
  }
}

List of all segments for a model

List all segments

Create new segment

Show child attributes

Detail info of a segment

Delete segment by uuid

List all segments for a model