Events

List raw events

Changed on

Use when debugging ingestion or exporting raw event data (e.g. support or audit). Returns a paginated list; supports time range and sorting.

post/events/query

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/events/query
  • Auth
    API key in header x-api-key

Request body

end_timestring date-time

End time of the events to be fetched in ISO 8601 format Defaults to now if not provided

event_idstring

Event ID is the idempotency key for the event

event_namestring

Event name / Unique identifier for the event in your system

external_customer_idstring

Customer ID in your system that was sent with the event

iter_first_keystring

First key to iterate over the events

iter_last_keystring

Last key to iterate over the events

offsetinteger

Offset to fetch the events and is set to 0 by default

orderstring

Order by condition. Allowed values (case sensitive): asc, desc (default: desc)

page_sizeinteger

Page size to fetch the events and is set to 50 by default

property_filtersobject

Property filters to filter the events by the keys in properties field of the event

sortstring

Sort by the field. Allowed values (case sensitive): timestamp, event_name (default: timestamp)

sourcestring

Source to filter the events by the source

start_timestring date-time

Start time of the events to be fetched in ISO 8601 format Defaults to last 7 days from now if not provided

Example request

{
  "end_time": "2024-12-09T00:00:00Z",
  "order": "desc",
  "sort": "timestamp",
  "start_time": "2024-11-09T00:00:00Z"
}

Response

OK

has_moreboolean
iter_first_keystring
iter_last_keystring
offsetinteger
total_countinteger

Changes

  • 0fb60b40c570Revision changes
    • info

      added the optional property // to the response with the status

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status