Skip to main content
POST
/
meters
/
{id}
/
query
JavaScript
import Limitry from '@limitry/sdk';

const client = new Limitry({
  apiKey: process.env['LIMITRY_API_KEY'], // This is the default and can be omitted
});

const response = await client.meters.query('id');

console.log(response.aggregation);
{
  "meterId": "mtr_total_tokens",
  "meterName": "total_tokens",
  "value": 125000,
  "aggregation": "sum"
}

Authorizations

Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Path Parameters

id
string
required

Meter ID

Body

application/json
customerId
string

Filter by customer

dimensions
object

Dimension filters

startDate
string<date-time>

Start date

endDate
string<date-time>

End date

Response

Meter value

meterId
string
required

Meter ID

meterName
string
required

Meter name

value
number
required

Aggregated value

aggregation
string
required

Aggregation type used