Skip to main content
GET
Fetch resource

Authorizations

X-API-KEY
string
header
required

API Key Authentication.

Path Parameters

id
string<uuid>
required

The unique identifier of the resource in our system.

Response

Schema representing a resource.

id
string<uuid>
required

The unique identifier of the resource in our system.

name
string
required

The name of the resource.

Example:

"Emails sent"

type
enum<string>
required

The type of the resource.

Available options:
unit,
currency
aggregation
enum<string>
required

The aggregation method used for this resource.

Available options:
sum,
last_during_period,
unique
aggregateByField
string
required

The aggregateByField property indicates which field will be considered when aggregating events.

Example:

"value"

billingModel
enum<string>
required

The billing model for this resource.

Available options:
in_full,
proration
itemId
string<uuid>
required

The related item identifier for this resource.

filters
object[]
required

The filters selecting the events this resource counts. Conditions repeated for the same property match if ANY condition matches (OR); different properties must ALL match (AND). At least one filter must use the property eventName.

Example:
archivedAt
string<date-time> | null
required

The timestamp when the resource was archived, or null if not archived.