GET
/
metrics
curl --request GET \
  --url https://api.withorb.com/v1/metrics \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "metadata": {},
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "active",
      "item": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "external_connections": [
          {
            "external_connection_name": "stripe",
            "external_entity_id": "<string>"
          }
        ]
      }
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Query Parameters

​
limit
integer
default:20

The number of items to fetch. Defaults to 20.

Required range: 1 <= x <= 100
​
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

​
created_at[gte]
string | null
​
created_at[gt]
string | null
​
created_at[lt]
string | null
​
created_at[lte]
string | null

Response

200
application/json
OK
​
data
object[]
required

The Metric resource represents a calculation of a quantity based on events. Metrics are defined by the query that transforms raw usage events into meaningful values for your customers.

​
pagination_metadata
object
required

Was this page helpful?