Get a list of usage events with multiple query options

Authorizations

Authorization

string

headerrequired

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

Query Parameters

nextToken

string

Pagination token used as a marker to get records from next page.

status

string

Filter option to filter by status.

account_id

string

Filter option to filter based on account id.

schema_name

string

Filter option to filter the events based on schema name.

pageSize

integer

Maximum page size expected by client to return the record list.

NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

Response

200 - application/json

Get batch events response

events

object[]

required

events.referenceId

string

required

Unique id generated by Togai to identify an event uniquely

events.eventPayload

object

required

Contents of the event

events.ingestionStatus

object

required

Status about the event ingestion.

events.customerId

string

The associated account belongs to this customer

Maximum length: 50

events.source

object

Source of ingestion of event

events.createdAt

string

required

Created time stamp of the event. This timestamp must be in ISO 8601 format.

nextToken

string

Maximum length: 500

Introduction

APIs

Get a list of usage events with multiple query options

Authorizations

Query Parameters

Response