List all events

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

Page number.

Example:

1

per_page

integer

Number of records per page.

Example:

20

external_subscription_id

string

External subscription ID

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

code

string

Filter events by its code.

Example:

"event-123"

timestamp_from_started_at

boolean

Requires external_subscription_id to be set. Filter events by timestamp after the subscription started at datetime.

Example:

true

timestamp_from

string<date-time>

Filter events by timestamp starting from a specific date.

Example:

"2022-08-08T00:00:00Z"

timestamp_to

string<date-time>

Filter events by timestamp up to a specific date.

Example:

"2022-08-08T00:00:00Z"

Response

Events

events

object[]

required

Show child attributes

events.lago_id

string<uuid>

required

Unique identifier assigned to the event within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the event's record within the Lago system

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

events.transaction_id

string

required

This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.

Example:

"transaction_1234567890"

events.lago_customer_id

string<uuid> | null

required

Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

events.code

string

required

The code that identifies a targeted billable metric. It is essential that this code matches the code property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.

Example:

"storage"

events.timestamp

string<date-time>

required

This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception.

Example:

"2022-04-29T08:59:51.123Z"

events.lago_subscription_id

string<uuid> | null

required

Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

events.external_subscription_id

string

required

The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the external_customer_id is not provided.

Example:

"sub_1234567890"

events.created_at

string<date-time>

required

The creation date of the event's record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application

Example:

"2022-04-29T08:59:51Z"

events.precise_total_amount_cents

string | null

The precise total amount that was sent in the event payload. This filed is used by the dynamic pricing model.

Example:

"1234.56"

events.properties

object

This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a sum_agg, max_agg, or unique_count_agg aggregation method. However, when using a simple count_agg, this object is not required.

Show child attributes

events.properties.operation_type

enum<string> | null

The operation_type field is only necessary when adding or removing a specific unit when the targeted billable metric adopts a unique_count_agg aggregation method. In other cases, the operation_type field is not required. The valid values for the operation_type field are add or remove, which indicate whether the unit is being added or removed from the unique count aggregation, respectively.

Available options:

add,

remove

events.properties.{key}

Example:

{ "gb": 10 }

API Reference

Authorizations

Query Parameters

Response