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

Custom Metrics REST API Guide

PreviousFile Upload REST API Guide NextSegments REST API Guide

Last updated 3 months ago

Was this helpful?

List all custom metrics

get

/v3/custom-metrics

Authorizations

Query parameters

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/custom-metrics' \
  --header 'Authorization: Bearer <token>'

200

400

401

403

500

{
  "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": "2025-02-06T09:51:15.002Z",
        "updated_at": "2025-02-06T09:51:15.002Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        }
      }
    ]
  }
}

List of all custom metrics

Create new custom metric

post

/v3/custom-metrics

Authorizations

Body

model_idstring uuidrequired

namestringrequired

descriptionstring

definitionstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/custom-metrics' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"model_id":"123e4567-e89b-12d3-a456-426614174000","name":"text","definition":"text"}'

200

400

401

403

404

500

{
  "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": "2025-02-06T09:51:15.002Z",
    "updated_at": "2025-02-06T09:51:15.002Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    }
  }
}

Custom metric successfully created

Detail info of a custom metric

get

/v3/custom-metrics/{uuid}

Authorizations

Path parameters

uuidstring uuidrequired

uuid path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/custom-metrics/{uuid}' \
  --header 'Authorization: Bearer <token>'

200

401

403

404

500

{
  "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": "2025-02-06T09:51:15.002Z",
    "updated_at": "2025-02-06T09:51:15.002Z",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    }
  }
}

Get detail info

Delete custom metric by uuid

delete

/v3/custom-metrics/{uuid}

Authorizations

Path parameters

uuidstring uuidrequired

uuid path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v3/custom-metrics/{uuid}' \
  --header 'Authorization: Bearer <token>'

200

400

401

403

404

500

No body

Success

List all custom metrics for a model

get

/v3/models/{model_id}/custom-metrics

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Query parameters

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/models/{model_id}/custom-metrics' \
  --header 'Authorization: Bearer <token>'

200

400

401

403

404

500

{
  "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": "2025-02-06T09:51:15.002Z",
        "updated_at": "2025-02-06T09:51:15.002Z",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        }
      }
    ]
  }
}

List of all custom metrics for a model