TOtogaihq
Event Management

Get a list of usage events with multiple query options

Changed on

This API let’s you to fetch a list of events with multiple query parameters

get/events

Request

Query parameters

nextTokenstring
Example:eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==

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

statusstring

Filter option to filter by status.

account_idstring
Example:1234

Filter option to filter based on account id.

schema_namestring
Example:Rides

Filter option to filter the events based on schema name.

pageSizeinteger
Example:10

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

Success response

nextTokenstring

Example response

{
  "events": [
    {
      "eventPayload": {
        "id": "c0b1306d-f506-43a6-856b-69221efaee6b",
        "timestamp": "2022-06-15T07:30:35.123",
        "attributes": [
          {
            "name": "message",
            "unit": "characters"
          }
        ]
      },
      "ingestionStatus": {
        "status": "INGESTION_COMPLETED",
        "statusDescription": "Ingestion Completed successfully"
      },
      "customerId": "1",
      "createdAt": "2022-06-15T07:30:35.123"
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

Changes

  • d078d3562056Revision changes
    • breaking

      the //// response property's maxLength was increased from 50 to 200 for the response status

    • warning

      added the new INGESTION_FAILED_INSUFFICIENT_CREDITS enum value to the /// response property for the response status

  • cc0b10fb537eRevision changes
    • warning

      added the new INGESTION_FAILED_INVALID_NAMED_LICENSE_EVENT enum value to the /// response property for the response status