Custom Metrics REST API Guide

List all custom metrics

get

List all custom metrics

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 all custom metrics

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/custom-metrics 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",
        "description": "text",
        "definition": "text",
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "asset_type": "ML_MODEL"
        },
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "created_at": "2025-08-29T01:03:34.061Z",
        "updated_at": "2025-08-29T01:03:34.061Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[email protected]"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[email protected]"
        }
      }
    ]
  }
}

Create new custom metric

post

Create new custom metric

Authorizations

Body

all ofOptional

Responses

200

Custom metric successfully created

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

post

POST /v3/custom-metrics HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "model_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "definition": "text"
}

{
  "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",
      "asset_type": "ML_MODEL"
    },
    "model": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "created_at": "2025-08-29T01:03:34.061Z",
    "updated_at": "2025-08-29T01:03:34.061Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    }
  }
}

Detail info of a custom metric

get

Detail info of a custom metric

Authorizations

Path parameters

uuidstring · uuidRequired

uuid path parameter

Responses

200

Get detail info

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

get

GET /v3/custom-metrics/{uuid} 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",
    "description": "text",
    "definition": "text",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "asset_type": "ML_MODEL"
    },
    "model": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "created_at": "2025-08-29T01:03:34.061Z",
    "updated_at": "2025-08-29T01:03:34.061Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    }
  }
}

Delete custom metric by uuid

delete

Delete custom metric by uuid

Authorizations

Path parameters

uuidstring · uuidRequired

uuid 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/custom-metrics/{uuid} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List all custom metrics for a model

get

List all custom metrics for 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 all custom metrics for 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}/custom-metrics 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",
        "description": "text",
        "definition": "text",
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "asset_type": "ML_MODEL"
        },
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "created_at": "2025-08-29T01:03:34.061Z",
        "updated_at": "2025-08-29T01:03:34.061Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[email protected]"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[email protected]"
        }
      }
    ]
  }
}

PreviousFile Upload REST API Guide NextSegments REST API Guide

Last updated 5 months ago

Was this helpful?