Skip to main content
GET
/
api
/
rules
/
metrics
Get metrics
curl --request GET \
  --url https://app.herondata.io/api/rules/metrics \
  --header 'x-api-key: <api-key>'
[
  {
    "date_range": "last_180_days",
    "description": "Total number of unique transactions",
    "group": "transaction_metrics",
    "label": "unique_transactions",
    "unit": "count"
  }
]

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

OK

​
date_range
string

The date range this metric covers

Example:

"last_180_days"

​
description
string

Human-readable description of the metric

Example:

"Total number of unique transactions"

​
group
string

The group/category this metric belongs to

Example:

"transaction_metrics"

​
label
string

The label/name of the metric

Example:

"unique_transactions"

​
unit
string

The unit of measurement for this metric

Example:

"count"