Custom Metrics

List all custom metrics

List all custom metrics

GEThttps://preprod.dev.fiddler.ai/v3/custom-metrics

Query parameters

Response

200400401403500

List of all custom metrics

Body

application/json

api_versionenum

API version of the response.

3.0

kindenum

Type of response, indicating a paginated response.

PAGINATED

dataobject

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/custom-metrics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403500

{
  "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": "2024-11-21T06:26:49.960Z",
        "updated_at": "2024-11-21T06:26:49.960Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[e-mail]"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[e-mail]"
        }
      }
    ]
  }
}

Create new custom metric

Create new custom metric

POSThttps://preprod.dev.fiddler.ai/v3/custom-metrics

Body

application/json

model_id*string (uuid)

name*string

descriptionstring

definition*string

Response

200400401403404500

Custom metric successfully created

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataall of

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/custom-metrics', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "model_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "definition": "text"
    }),
});
const data = await response.json();

Response

200400401403404500

{
  "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": "2024-11-21T06:26:49.960Z",
    "updated_at": "2024-11-21T06:26:49.960Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    }
  }
}

Detail info of a custom metric

Detail info of a custom metric

GEThttps://preprod.dev.fiddler.ai/v3/custom-metrics/{uuid}

Path parameters

uuid*string (uuid)

uuid path parameter

Response

200401403404500

Get detail info

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataall of

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/custom-metrics/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403404500

{
  "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": "2024-11-21T06:26:49.960Z",
    "updated_at": "2024-11-21T06:26:49.960Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    }
  }
}

Delete a custom metric

Delete custom metric by uuid

DELETEhttps://preprod.dev.fiddler.ai/v3/custom-metrics/{uuid}

Path parameters

uuid*string (uuid)

uuid path parameter

Response

200400401403404500

Success

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/custom-metrics/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404500

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

List all custom metrics for a model

List all custom metrics for a model

GEThttps://preprod.dev.fiddler.ai/v3/models/{model_id}/custom-metrics

Path parameters

model_id*string (uuid)

model id path parameter

Query parameters

Response

200400401403404500

List of all custom metrics for a model

Body

application/json

api_versionenum

API version of the response.

3.0

kindenum

Type of response, indicating a paginated response.

PAGINATED

dataobject

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}/custom-metrics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "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": "2024-11-21T06:26:49.960Z",
        "updated_at": "2024-11-21T06:26:49.960Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[e-mail]"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[e-mail]"
        }
      }
    ]
  }
}