Skip to main content
GET
/
api
/
v1
/
metrics
List metrics
curl --request GET \
  --url https://app.dimred.com/api/v1/metrics \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "organization_id": "<string>",
    "project_id": "<string>",
    "metric_name": "<string>",
    "description": "<string>",
    "metric_definition": "<string>",
    "s3_path": "<string>",
    "metric_config": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

API key for authentication. Obtain from your DimRed dashboard. The organization context is automatically derived from the API key.

Query Parameters

​
project_id
string

Optional project identifier to filter metrics

Response

Metrics retrieved successfully

​
id
string

Unique identifier for the metric

​
organization_id
string

Organization identifier

​
project_id
string

Project identifier

​
metric_name
string

Name of the metric

​
description
string | null

Description of the metric

​
metric_definition
string | null

Python code definition

​
s3_path
string | null

S3 path for stored metric code

​
metric_config
object | null

Additional configuration including creation_method and metric_type

​
created_at
string<date-time>

ISO 8601 timestamp of creation

​
updated_at
string<date-time> | null

ISO 8601 timestamp of last update