Ingest event if a user is entitled to a feature

POST

entitled

Copy
curl --request POST \
  --url https://api.togai.com/entitled \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event": {
    "schemaName": "<string>",
    "id": "c0b1306d-f506-43a6-856b-69221efaee6b",
    "timestamp": "2022-06-15T07:30:35.123",
    "accountId": 1,
    "attributes": [
      {
        "name": "message",
        "value": 100,
        "unit": "characters"
      }
    ],
    "dimensions": {}
  }
}'

Copy
{
  "success": true
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Payload for ingesting events

event

object

required

Contents of the event

event.schemaName

string

required

Name of the Event Schema. Know more about event schema

Required string length: 1 - 50

event.timestamp

string

required

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

Example:

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

event.accountId

string

required

The event will be associated with the provided account

Maximum length: 512

Example:

1

event.attributes

object[]

required

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

Metric to be recorded

event.dimensions

object

required

Dimensions are tags/labels associated with the events.

event.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

200

application/json

Success response

success

boolean

required

Example:

true

Ingest events to Togai in batch Get Feature credits balance

Copy
curl --request POST \
  --url https://api.togai.com/entitled \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event": {
    "schemaName": "<string>",
    "id": "c0b1306d-f506-43a6-856b-69221efaee6b",
    "timestamp": "2022-06-15T07:30:35.123",
    "accountId": 1,
    "attributes": [
      {
        "name": "message",
        "value": 100,
        "unit": "characters"
      }
    ],
    "dimensions": {}
  }
}'

Copy
{
  "success": true
}

Introduction

APIs

Authorizations

Body

Response