List Billable Metrics

GET

metrics

curl "https://api.alguna.io/metrics?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": "mtr_02zBU3PJ3hJurtFSxDD3Ol",
  "description": "No. of Amex Consumer Cards",
  "name": "Amex Consumer",
  "eventName": "transactions",
  "filters": [
    {
      "operator": "and",
      "filters": [
        {
          "field": "card_scheme",
          "operator": "equal",
          "value": "amex"
        },
        {
          "field": "card_offering",
          "operator": "equal",
          "value": "consumer"
        }
      ]
    }
  ],
  "aggregation": {
    "method": "sum",
    "field": "txn_value"
  },
  "createdAt": "2025-02-24T12:09:05.350876Z",
  "updatedAt": "2025-02-24T12:09:05.350877Z",
  "organizationID": "8641473c-2d34-46c6-b712-c893934fc8fb"
}

Retrieves a paginated list of all billable metrics. You can filter and sort the results using query parameters.

Query Parameters

page

integer

default:"1"

The page number to retrieve (1-indexed).

limit

integer

default:"10"

The number of metrics to return per page. Must be one of: 5, 10, 25, 50, or 100. Values exceeding 100 are capped automatically.

filters

string

A JSON-encoded array of filter objects. Each filter object has the following properties:

Show Filter Object

field

string

required

The field to filter on. Supported fields:

Field	Operators	Description
`eventName`	`in`	The event name that triggers the metric
`aggregationMethod`	`in`	The aggregation method (e.g. `sum`, `count`, `max`)
`aggregationField`	`in`	The event property being aggregated
`tagIds`	`in`	Tag IDs associated with the metric

operator

string

required

The comparison operator. All metric filter fields support the in operator for matching any value in a comma-separated list.

value

string

required

The value to match against. Use comma-separated values with the in operator.

sort

string

Sort specification in field:order format. Order is either asc (ascending) or desc (descending).Sortable fields: name.

curl "https://api.alguna.io/metrics?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "id": "mtr_02zBU3PJ3hJurtFSxDD3Ol",
  "description": "No. of Amex Consumer Cards",
  "name": "Amex Consumer",
  "eventName": "transactions",
  "filters": [
    {
      "operator": "and",
      "filters": [
        {
          "field": "card_scheme",
          "operator": "equal",
          "value": "amex"
        },
        {
          "field": "card_offering",
          "operator": "equal",
          "value": "consumer"
        }
      ]
    }
  ],
  "aggregation": {
    "method": "sum",
    "field": "txn_value"
  },
  "createdAt": "2025-02-24T12:09:05.350876Z",
  "updatedAt": "2025-02-24T12:09:05.350877Z",
  "organizationID": "8641473c-2d34-46c6-b712-c893934fc8fb"
}

items

array

List of billable metric objects.

Show Metric Object

string

The unique identifier for the metric.

name

string

The name of the metric.

description

string

A brief description of what the metric measures.

eventName

string

The event that triggers the metric.

filters

[]object

An array of filter groups applied to the metric to narrow down the events counted.

Show Filter Group Properties

operator

string

The logical operator (e.g., “and”) used to combine the filters within the group.

filters

[]object

An array of individual filters within the group.

Show Filter Properties

field

string

The event property to filter by.

operator

string

The condition to apply (e.g., “equal”).

value

string

The value that the event property must match.

aggregation

object

The aggregation settings that define how the events are calculated to produce the metric value.

Show Aggregation Properties

method

string

The aggregation method to apply (e.g., “sum”).

field

string

The event property that is aggregated.

createdAt

datetime

The timestamp when the metric was created.

updatedAt

datetime

The timestamp when the metric was last updated.

organizationID

string

The unique identifier for the organization associated with the metric.

pageCount

integer

Total number of pages available based on the current limit.

limit

integer

The number of items per page used for this request.

Update Billable Metric

⌘I

curl "https://api.alguna.io/metrics?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": "mtr_02zBU3PJ3hJurtFSxDD3Ol",
  "description": "No. of Amex Consumer Cards",
  "name": "Amex Consumer",
  "eventName": "transactions",
  "filters": [
    {
      "operator": "and",
      "filters": [
        {
          "field": "card_scheme",
          "operator": "equal",
          "value": "amex"
        },
        {
          "field": "card_offering",
          "operator": "equal",
          "value": "consumer"
        }
      ]
    }
  ],
  "aggregation": {
    "method": "sum",
    "field": "txn_value"
  },
  "createdAt": "2025-02-24T12:09:05.350876Z",
  "updatedAt": "2025-02-24T12:09:05.350877Z",
  "organizationID": "8641473c-2d34-46c6-b712-c893934fc8fb"
}

​Query Parameters

​Response

Query Parameters

Response