Baselines REST API Guide

List of baselines based on user permissions and filters

get

List of baselines based on user permissions and filters

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

200

List of baselines

application/json

Responseall of

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

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

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "STATIC",
        "row_count": 1,
        "start_time": 1,
        "end_time": 1,
        "offset_delta": 1,
        "window_bin_size": "Hour",
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "environment": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "PRE_PRODUCTION",
          "name": "text"
        },
        "created_at": "2025-07-01T23:08:43.320Z",
        "updated_at": "2025-07-01T23:08:43.320Z"
      }
    ]
  }
}

add baseline to a model

post

Adds a baseline to a model

Authorizations

Body

namestringRequired

A name describing the baseline

model_idstring · uuidRequired

The unique identifier for the model associated with the baseline

typestring · enumRequired

The type of baseline, indicating whether it is STATIC or ROLLING.

Possible values:

env_typestring · enumRequired

The environment type for the baseline, indicating whether it applies to production or pre-production environments.

Possible values:

env_idstring · uuid | nullableOptional

Required when env_type is PRE_PRODUCTION

start_timeintegerOptional

Start time in milliseconds from epoch for production data

end_timeintegerOptional

End time in milliseconds from epoch for production data

offset_deltainteger · min: 1Optional

x is offset delta for offset=x*window_bin_size

window_bin_sizestring · enumOptional

Window size to be used for relative baseline

Possible values:

Responses

200

successful baseline creation

application/json

Responseall of

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post

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

{
  "name": "text",
  "model_id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "STATIC",
  "env_type": "PRODUCTION",
  "env_id": "123e4567-e89b-12d3-a456-426614174000",
  "start_time": 1,
  "end_time": 1,
  "offset_delta": 1,
  "window_bin_size": "Hour"
}

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "STATIC",
    "row_count": 1,
    "start_time": 1,
    "end_time": 1,
    "offset_delta": 1,
    "window_bin_size": "Hour",
    "model": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "environment": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "PRE_PRODUCTION",
      "name": "text"
    },
    "created_at": "2025-07-01T23:08:43.320Z",
    "updated_at": "2025-07-01T23:08:43.320Z"
  }
}

Get baseline details

get

Get baseline details

Authorizations

Path parameters

baseline_idstring · uuidRequired

baseline id path parameter

Responses

200

application/json

Responseall of

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

get

GET /v3/baselines/{baseline_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "STATIC",
    "row_count": 1,
    "start_time": 1,
    "end_time": 1,
    "offset_delta": 1,
    "window_bin_size": "Hour",
    "model": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "environment": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "PRE_PRODUCTION",
      "name": "text"
    },
    "created_at": "2025-07-01T23:08:43.320Z",
    "updated_at": "2025-07-01T23:08:43.320Z"
  }
}

Delete baseline from a model

delete

Delete baseline from a model

Authorizations

Path parameters

baseline_idstring · uuidRequired

baseline id path parameter

Responses

200

Success

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

delete

DELETE /v3/baselines/{baseline_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List of baselines of a model

get

List of baselines of 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

200

List of baselines of a model

application/json

Responseall of

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

get

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

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "STATIC",
        "row_count": 1,
        "start_time": 1,
        "end_time": 1,
        "offset_delta": 1,
        "window_bin_size": "Hour",
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "environment": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "PRE_PRODUCTION",
          "name": "text"
        },
        "created_at": "2025-07-01T23:08:43.320Z",
        "updated_at": "2025-07-01T23:08:43.320Z"
      }
    ]
  }
}

PreviousSegments REST API Guide NextJobs REST API Guide

Last updated 3 months ago

Was this helpful?