Skip to main content
GET
/
metrics
/
{metric_id}
Get metric
curl --request GET \
  --url https://api.withorb.com/v1/metrics/{metric_id} \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {},
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "item": {
    "metadata": {},
    "id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "external_connections": [
      {
        "external_entity_id": "<string>"
      }
    ],
    "archived_at": "2023-11-07T05:31:56Z"
  },
  "parameter_definitions": [
    {}
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.withorb.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
metric_id
string
required

Response

OK

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.

​
metadata
Metadata · object
required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

​
id
string
required
​
name
string
required
​
description
string | null
required
​
status
enum<string>
required
Available options:
active,
draft,
archived
​
item
Item · object
required

The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics, and prices and are used for defining external sync behavior for invoices and tax calculation purposes.

​
parameter_definitions
Parameter Definitions · object[] | null