Skip to main content
POST
Run a table-shaped custom metric

Headers

x-project-id
string
required

Project ID to specify the project context

Body

application/json
metric
string
required

Metric identifier (matches id returned by GET /analytics/custom-metrics)

Example:

"sample-metric-table"

filter
object

Filter payload. Schema is metric-specific and validated by the dispatcher against the registered DTO class.

Example:

Response

metric
string
required

Metric id (matches discovery list)

title
string
required

Human-readable card title

columns
object[]
required
rows
object[]
required

Row data; keys match columns[].key

description
string

Short description rendered under the title

defaultSort
object
highlight
object

Row-level highlight rule (e.g. tint the leader row)