Skip to main content
GET
/
customers
/
{id}
/
usage
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.customers.getUsage('id', {
  endDate: '2019-12-27T18:11:19.117Z',
  startDate: '2019-12-27T18:11:19.117Z',
});

console.log(response.customerId);
{
  "customerId": "<string>",
  "totalEvents": 123,
  "values": {}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Customer ID (internal or external)

Query Parameters

startDate
string<date-time>
required

Start date (ISO 8601)

endDate
string<date-time>
required

End date (ISO 8601)

Response

Customer usage summary

customerId
string
required

Customer identifier

totalEvents
number
required

Total number of events

values
object
required

Aggregated values