Ingest events to Togai in batch - Togai documentation

POST

ingestBatch

curl --request POST \
  --url https://api.togai.com/ingestBatch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "events": [
    {
      "timestamp": "2022-06-15T07:30:35.123",
      "schemaName": "travelCompletedEvent",
      "id": "c0b1306d-f506-43a6-856b-69221efaee6b",
      "accountId": "1",
      "attributes": [
        {
          "name": "distanceTravelled",
          "value": "50",
          "unit": "Miles"
        },
        {
          "name": "timeSpent",
          "value": "60",
          "unit": "Minutes"
        }
      ],
      "dimensions": {
        "location": "Seattle",
        "costCenterCode": "1234",
        "travelType": "Business"
      }
    },
    {
      "timestamp": "2022-06-15T07:30:35.123",
      "schemaName": "sendMessageEvent",
      "id": "c0b1306d-f506-43a6-856b-69221efaee6c",
      "accountId": "1",
      "attributes": [
        {
          "name": "messageSentCount",
          "value": "50",
          "unit": "None"
        },
        {
          "name": "sizeOfMessage",
          "value": "60",
          "unit": "KiloBytes"
        }
      ],
      "dimensions": {
        "location": "Seattle",
        "costCenterCode": "1234",
        "messageProviderName": "Twilio"
      }
    }
  ]
}'

{
  "success": true
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Request body to ingest events in batch to Togai usage and billing management service.

Payload for ingesting batch events

events

object[]

required

Contents of the event

events.schemaName

string

required

Name of the Event Schema. Know more about event schema

Required string length: 1 - 50

events.timestamp

string

required

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

Example:

"2022-06-15T07:30:35.123"

events.accountId

string

required

The event will be associated with the provided account

Maximum length: 512

Example:

1

events.attributes

object[]

required

Attributes are numeric values. It can be usage metric which you push to Togai

Metric to be recorded

events.dimensions

object

required

Dimensions are tags/labels associated with the events.

events.id

string

Togai restricts users to ingest events with same id within a period of 45 days. This restriction is common for /entitled API, /ingest API and /ingestBatch API. i.e, an id used on /ingest API will not be allowed on /ingestBatch or /entitled APIs

Maximum length: 512

Example:

"c0b1306d-f506-43a6-856b-69221efaee6b"

Response

202

application/json

Successfully accepted to process all the events from payload.

success

boolean

Example:

true

statusCode

integer

name

string

message

string

Maximum length: 500

code

string

details

object

Ingest events to Togai Ingest event if a user is entitled to a feature

curl --request POST \
  --url https://api.togai.com/ingestBatch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "events": [
    {
      "timestamp": "2022-06-15T07:30:35.123",
      "schemaName": "travelCompletedEvent",
      "id": "c0b1306d-f506-43a6-856b-69221efaee6b",
      "accountId": "1",
      "attributes": [
        {
          "name": "distanceTravelled",
          "value": "50",
          "unit": "Miles"
        },
        {
          "name": "timeSpent",
          "value": "60",
          "unit": "Minutes"
        }
      ],
      "dimensions": {
        "location": "Seattle",
        "costCenterCode": "1234",
        "travelType": "Business"
      }
    },
    {
      "timestamp": "2022-06-15T07:30:35.123",
      "schemaName": "sendMessageEvent",
      "id": "c0b1306d-f506-43a6-856b-69221efaee6c",
      "accountId": "1",
      "attributes": [
        {
          "name": "messageSentCount",
          "value": "50",
          "unit": "None"
        },
        {
          "name": "sizeOfMessage",
          "value": "60",
          "unit": "KiloBytes"
        }
      ],
      "dimensions": {
        "location": "Seattle",
        "costCenterCode": "1234",
        "messageProviderName": "Twilio"
      }
    }
  ]
}'

{
  "success": true
}

Introduction

APIs

Authorizations

Body

Response