events

Get all events

Fetches all usage events, and can be filtered as needed. This endpoint is rate-limited to 600 requests per minute per merchant.

get/v1/events

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v1/events
  • Auth: API key in header Authorization

Query parameters

startDatestring

Start date for filtering events (UTC) (format: YYYY-MM-DDTHH:mm:ss)

endDatestring

End date for filtering events (UTC) (format: YYYY-MM-DDTHH:mm:ss)

ingestStartDatestring

Start ingest timestamp for filtering events (UTC) (format: YYYY-MM-DDTHH:mm:ss)

ingestEndDatestring

End ingest timestamp for filtering events (UTC) (format: YYYY-MM-DDTHH:mm:ss)

customerIdstring

Tabs Customer ID to filter events

eventTypeIdstring

Event type ID to filter events

sourcestring

Source to filter events

limitinteger

Number of events to return (default: 50, max: 1000)

cursorstring

Cursor for pagination

orderDirectionstring

Sort direction (asc/desc)

skipDeletionEventsboolean

Include deleted events in the response (default: true)

idempotencyKeysstring[]

Idempotency key(s) to filter events.

Response

Events retrieved successfully

countinteger

Total count of events

nextCursorstring

Cursor for the next page of results

hasMoreboolean

Whether there are more results available

Changes

No recorded changes to this operation across all 1 revision of this API.