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

console.log(response.data);
{
  "data": [
    {
      "dimension": "<string>",
      "totalEvents": 123,
      "values": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

groupBy
string
required

Dimension to group by (customer_id, event_type, or dimension key)

customerId
string

Filter by customer ID

eventType
string

Filter by event type

startDate
string<date-time>
required

Start date (ISO 8601)

endDate
string<date-time>
required

End date (ISO 8601)

Response

Events breakdown

data
object[]
required