Skip to main content
POST
/
{slug}
/
metrics
/
pkl-metrics
Create PKL metric
curl --request POST \
  --url https://api.dimred.com/api/v2/{slug}/metrics/pkl-metrics \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "metric_id": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "metric_name": "<string>",
  "s3_path": "<string>",
  "metric_description": "<string>",
  "metric_config": {}
}'
{
  "metric_id": "<string>",
  "metric_name": "<string>",
  "status": "<string>",
  "message": "<string>"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

slug
string
required

Organization slug

Body

application/json
organization_id
string
required

Organization ID

project_id
string
required

Project ID

metric_name
string
required

Human-readable metric name

s3_path
string
required

Path to the metric file in S3

metric_description
string
required

Metric description

metric_id
string

Optional metric ID (generated if not provided)

metric_config
object

Optional configuration parameters

Response

200 - application/json

PKL metric created successfully

metric_id
string
required

Created metric ID

metric_name
string
required

Metric name

status
string
required

Creation status

message
string
required

Status message

I