Baseline

List of baselines based on user permissions and filters

List of baselines based on user permissions and filters

GET/v3/baselines

Query parameters

Response

200400401403500

List of baselines

Body

application/json

api_versionenum

API version of the response.

2.03.0

kindenum

Type of response, indicating a paginated response.

PAGINATED

dataobject

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/baselines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403500

{
  "api_version": "2.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "STATIC",
        "row_count": 0,
        "start_time": 0,
        "end_time": 0,
        "offset_delta": 0,
        "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-01-22T03:31:40.870Z",
        "updated_at": "2025-01-22T03:31:40.870Z"
      }
    ]
  }
}

add baseline to a model

Adds a baseline to a model

POST/v3/baselines

Body

application/json

name*string

A name describing the baseline

model_id*string (uuid)

The unique identifier for the model associated with the baseline

type*enum

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

STATICROLLING

env_type*enum

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

PRODUCTIONPRE_PRODUCTION

env_idnullable string (uuid)

Required when env_type is PRE_PRODUCTION

start_timeinteger

Start time in milliseconds from epoch for production data

end_timeinteger

End time in milliseconds from epoch for production data

offset_deltainteger

x is offset delta for offset=x*window_bin_size

window_bin_sizeWindowBinSize (enum)

Window size to be used for relative baseline

HourDayWeekMonth

Response

200400401403409500

successful baseline creation

Body

application/json

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataBaseline (all of)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/baselines', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "model_id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "STATIC",
      "env_type": "PRODUCTION"
    }),
});
const data = await response.json();

Response

200400401403409500

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "STATIC",
    "row_count": 0,
    "start_time": 0,
    "end_time": 0,
    "offset_delta": 0,
    "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-01-22T03:31:40.870Z",
    "updated_at": "2025-01-22T03:31:40.870Z"
  }
}

Get baseline details

Get baseline details

GET/v3/baselines/{baseline_id}

Path parameters

baseline_id*string (uuid)

baseline id path parameter

Response

200400401403404500

OK

Body

application/json

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataBaseline (all of)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/baselines/{baseline_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "STATIC",
    "row_count": 0,
    "start_time": 0,
    "end_time": 0,
    "offset_delta": 0,
    "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-01-22T03:31:40.870Z",
    "updated_at": "2025-01-22T03:31:40.870Z"
  }
}

Delete baseline from a model

Delete baseline from a model

DELETE/v3/baselines/{baseline_id}

Path parameters

baseline_id*string (uuid)

baseline id path parameter

Response

200400401403404500

Success

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/baselines/{baseline_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404500

{
  "api_version": "2.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "text"
      }
    ]
  }
}

List of baselines of a model

List of baselines of a model

GET/v3/models/{model_id}/baselines

Path parameters

model_id*string (uuid)

model id path parameter

Query parameters

Response

200400401403404500

List of baselines of a model

Body

application/json

api_versionenum

API version of the response.

2.03.0

kindenum

Type of response, indicating a paginated response.

PAGINATED

dataobject

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v3/models/{model_id}/baselines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "api_version": "2.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "STATIC",
        "row_count": 0,
        "start_time": 0,
        "end_time": 0,
        "offset_delta": 0,
        "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-01-22T03:31:40.870Z",
        "updated_at": "2025-01-22T03:31:40.870Z"
      }
    ]
  }
}