GEgetlago
events

List all events

This endpoint is used for retrieving all events.

get/events

Request

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

external_subscription_idstring
Example:5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba

External subscription ID

codestring
Example:event-123

Filter events by code.

timestamp_from_started_atboolean
Example:true

Requires external_subscription_id to be set, and cannot be combined with timestamp_from. Filter events by timestamp after the subscription started at datetime.

timestamp_fromstring date-time
Example:2022-08-08T00:00:00Z

Filter events by timestamp starting from a specific date.

timestamp_tostring date-time
Example:2022-08-08T00:00:00Z

Filter events by timestamp up to a specific date.

Response

Events

Example response

{
  "events": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "transaction_id": "transaction_1234567890",
      "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "code": "storage",
      "timestamp": "2022-04-29T08:59:51.123Z",
      "precise_total_amount_cents": "1234.56",
      "properties": {
        "gb": 10
      },
      "lago_subscription_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "external_subscription_id": "sub_1234567890",
      "created_at": "2022-04-29T08:59:51Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.