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

Baseline

List of baselines based on user permissions and filters

List of baselines based on user permissions and filters

GEThttps://preprod.dev.fiddler.ai/v3/baselines
Query parameters
Response

List of baselines

Body
api_versionenum

API version of the response.

3.0
kindenum

Type of response, indicating a paginated response.

PAGINATED
dataobject
dataobject
Request
const response = await fetch('https://preprod.dev.fiddler.ai/v3/baselines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "STATIC",
        "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": "2024-09-19T21:22:03.264Z",
        "updated_at": "2024-09-19T21:22:03.264Z"
      }
    ]
  }
}

Add baseline to a model

Adds a baseline to a model

POSThttps://preprod.dev.fiddler.ai/v3/baselines
Body
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

successful baseline creation

Body
api_versionenum

API version.

3.0
kindenum

Type of response, indicating a normal response.

NORMAL
dataBaseline (all of)
Request
const response = await fetch('https://preprod.dev.fiddler.ai/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
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "STATIC",
    "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": "2024-09-19T21:22:03.264Z",
    "updated_at": "2024-09-19T21:22:03.264Z"
  }
}

Get baseline details

Get baseline details

GEThttps://preprod.dev.fiddler.ai/v3/baselines/{baseline_id}
Path parameters
baseline_id*string (uuid)

baseline id path parameter

Response

OK

Body
api_versionenum

API version.

3.0
kindenum

Type of response, indicating a normal response.

NORMAL
dataBaseline (all of)
Request
const response = await fetch('https://preprod.dev.fiddler.ai/v3/baselines/{baseline_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "STATIC",
    "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": "2024-09-19T21:22:03.264Z",
    "updated_at": "2024-09-19T21:22:03.264Z"
  }
}

Delete baseline from a model

Delete baseline from a model

DELETEhttps://preprod.dev.fiddler.ai/v3/baselines/{baseline_id}
Path parameters
baseline_id*string (uuid)

baseline id path parameter

Response

Success

Request
const response = await fetch('https://preprod.dev.fiddler.ai/v3/baselines/{baseline_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
{
  "api_version": "3.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

GEThttps://preprod.dev.fiddler.ai/v3/models/{model_id}/baselines
Path parameters
model_id*string (uuid)

model id path parameter

Query parameters
Response

List of baselines of a model

Body
api_versionenum

API version of the response.

3.0
kindenum

Type of response, indicating a paginated response.

PAGINATED
dataobject
dataobject
Request
const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}/baselines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "STATIC",
        "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": "2024-09-19T21:22:03.264Z",
        "updated_at": "2024-09-19T21:22:03.264Z"
      }
    ]
  }
}
PreviousSegmentsNextJobs

© 2024 Fiddler AI