Correct an ingested event

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

{
  "data": [
    {
      "referenceId": "event.21OpEx4DHQu.CZlyh",
      "eventPayload": {
        "timestamp": "2023-02-23T14:25:10Z",
        "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"
        }
      },
      "ingestionStatus": {
        "status": "INGESTION_COMPLETED_EVENT_NOT_METERED",
        "statusDescription": "Event ingestion completed successfully but the event is not associated with any bill plan."
      },
      "customerId": "CUS0001",
      "source": {
        "id": "ENTITLED",
        "type": "ENTITLED"
      },
      "createdAt": "2023-02-23T14:25:10Z",
      "status": "REVERTED",
      "reason": "Event Reverted"
    },
    {
      "referenceId": "event.23OrTx4FGQu.XVpzf",
      "eventPayload": {
        "timestamp": "2023-02-23T14:25:10Z",
        "schemaName": "smsSentEvent",
        "id": "sdvb325j-f506-43a6-856b-69221efaee6b",
        "accountId": "1",
        "attributes": [
          {
            "name": "smsCount",
            "value": "50",
            "unit": "count"
          }
        ],
        "dimensions": {}
      },
      "ingestionStatus": {
        "status": "INGESTION_COMPLETED_EVENT_NOT_METERED",
        "statusDescription": "Event ingestion completed successfully but the event is not associated with any bill plan."
      },
      "customerId": "CUS0001",
      "source": {
        "id": "",
        "type": ""
      },
      "createdAt": "2023-01-01T14:25:10Z",
      "status": "FAILED",
      "reason": "Event was ingested in past pricing cycle"
    }
  ]
}

Event Management

Correct an ingested event

This API lets you to correct events. Available in both synchronous and asynchronous mode

Usages: Reduction of all usages associated with this event
Revenue: Reduction of all revenues associated with this event
Entitlements: Entitlements(Feature Credits) consumed by this event are granted back to the account.

Possible Actions:

UNDO: Undo all usages, revenue and entitlements associated with an event
REDO: Performs UNDO and re-ingests the same event
REDO_EVENT: Performs UNDO and re-ingests the correction payload of the event

POST

events

correction

Correct an ingested event

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

{
  "data": [
    {
      "referenceId": "event.21OpEx4DHQu.CZlyh",
      "eventPayload": {
        "timestamp": "2023-02-23T14:25:10Z",
        "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"
        }
      },
      "ingestionStatus": {
        "status": "INGESTION_COMPLETED_EVENT_NOT_METERED",
        "statusDescription": "Event ingestion completed successfully but the event is not associated with any bill plan."
      },
      "customerId": "CUS0001",
      "source": {
        "id": "ENTITLED",
        "type": "ENTITLED"
      },
      "createdAt": "2023-02-23T14:25:10Z",
      "status": "REVERTED",
      "reason": "Event Reverted"
    },
    {
      "referenceId": "event.23OrTx4FGQu.XVpzf",
      "eventPayload": {
        "timestamp": "2023-02-23T14:25:10Z",
        "schemaName": "smsSentEvent",
        "id": "sdvb325j-f506-43a6-856b-69221efaee6b",
        "accountId": "1",
        "attributes": [
          {
            "name": "smsCount",
            "value": "50",
            "unit": "count"
          }
        ],
        "dimensions": {}
      },
      "ingestionStatus": {
        "status": "INGESTION_COMPLETED_EVENT_NOT_METERED",
        "statusDescription": "Event ingestion completed successfully but the event is not associated with any bill plan."
      },
      "customerId": "CUS0001",
      "source": {
        "id": "",
        "type": ""
      },
      "createdAt": "2023-01-01T14:25:10Z",
      "status": "FAILED",
      "reason": "Event was ingested in past pricing cycle"
    }
  ]
}

Query Parameters: Allowed filter combinations

All matching events will be considered for correction

Sync mode: Maximum of first 30 events matching the filters with the default sort order being EVENT_SOURCE_TIME DESC, EVENT_ID ASC can be corrected in a single request.
Async mode: When query parameter async = true is given, events matching the filters will be considered for correction and takes place in background.
Status of background job can be obtained using List Jobs API

Query Parameters

account_id

string

required

Unique identifier of the account corresponding to the event

string

Unique identifier of an event generated by Togai for reference

event_id

string

Identifier of an event provided by the user

event_source_time

string

Timestamp of an event provided by the user

created_at

string

Timestamp corresponding to the event ingestion time in Togai

async

boolean

Determines the mode of the correction. Defaults to false

Allowed Combinations

account_idaccount_id, idaccount_id, event_idaccount_id, event_source_timeaccount_id, event_id, created_ataccount_id, event_id, event_source_time

Authorizations

Authorization

string

header

required

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

Query Parameters

action

enum<string>

required

Action to perform in event correction

Available options:

UNDO,

REDO,

REDO_EVENT

Example:

"UNDO"

require_confirmation

boolean

Specifies whether to start a migration only after a confirmation

Example:

false

Body

application/json

Event Correction Payload for event correction

event

object

Contents of the event

Show child attributes

event.schemaName

string

required

Name of the Event Schema. Know more about event schema

Required string length: 1 - 50

event.timestamp

string<date-time>

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 string length: 512

Example:

1

event.attributes

object[]

required

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

Maximum array length: 10

Show child attributes

event.attributes.name

string

required

Name of the event attribute

Required string length: 1 - 50

Example:

"message"

event.attributes.value

string

required

Value of the event attribute

Example:

100

event.attributes.unit

string

Unit with which the attribute value was measured. Natively supported units - "Meters, Miles, Kilometers, Grams, Kilograms, ounces, Pounds, Minutes, Hours, Seconds, Milliseconds, Microseconds, None". Clients are free to add any other custom units.

Required string length: 1 - 50

Example:

"characters"

event.dimensions

object

required

Dimensions are tags/labels associated with the events.

Show child attributes

event.dimensions.{key}

string

Required string length: 1 - 200

Example:

{ "Country": "India" }

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 string length: 512

Example:

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

Response

Success response

Events Correction response

data

object[]

required

Required array length: 1 - 50 elements

Show child attributes

data.referenceId

string

required

Unique id generated by Togai to identify an event uniquely

data.eventPayload

object

required

Contents of the event

Show child attributes

data.eventPayload.schemaName

string

required

Name of the Event Schema. Know more about event schema

Required string length: 1 - 50

data.eventPayload.timestamp

string<date-time>

required

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

Example:

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

data.eventPayload.accountId

string

required

The event will be associated with the provided account

Maximum string length: 512

Example:

1

data.eventPayload.attributes

object[]

required

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

Maximum array length: 10

Show child attributes

data.eventPayload.attributes.name

string

required

Name of the event attribute

Required string length: 1 - 50

Example:

"message"

data.eventPayload.attributes.value

string

required

Value of the event attribute

Example:

100

data.eventPayload.attributes.unit

string

Required string length: 1 - 50

Example:

"characters"

data.eventPayload.dimensions

object

required

Dimensions are tags/labels associated with the events.

Show child attributes

data.eventPayload.dimensions.{key}

string

Required string length: 1 - 200

Example:

{ "Country": "India" }

data.eventPayload.id

string

Maximum string length: 512

Example:

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

data.ingestionStatus

object

required

Status about the event ingestion.

Show child attributes

data.ingestionStatus.status

enum<string>

required

Ingestion status

Available options:

INGESTION_IN_PROGRESS,

INGESTION_FAILED,

INGESTION_FAILED_SCHEMA_NOT_DEFINED,

INGESTION_FAILED_ENRICHMENT_FAILED,

INGESTION_FAILED_UNITS_INVALID,

INGESTION_COMPLETED_NO_MATCHING_METERS,

INGESTION_COMPLETED_EVENT_METERED,

INGESTION_COMPLETED_EVENT_NOT_METERED,

INGESTION_FAILED_PAST_GRACE_PERIOD,

INGESTION_FAILED_ACCOUNT_NOT_FOUND,

INGESTION_FAILED_DUPLICATE_EVENT,

INGESTION_FAILED_NO_EVENT_ID,

INGESTION_FAILED_INVALID_NAMED_LICENSE_EVENT,

INGESTION_FAILED_INSUFFICIENT_CREDITS,

REVERTED,

UNKNOWN

Example:

"INGESTION_COMPLETED"

data.ingestionStatus.statusDescription

string

Maximum string length: 250

Example:

"Ingestion Completed successfully"

data.createdAt

string<date-time>

required

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

Example:

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

data.status

enum<string>

required

Status of the event requested for correction

Available options:

REVERTED,

REVERTED_AND_REINGESTED,

FAILED

data.reason

string

required

Status description of the event requested for correction

data.customerId

string

The associated account belongs to this customer

Maximum string length: 50

Example:

"1"

data.source

object

Source of ingestion of event

Show child attributes

data.source.id

string

required

Unique identifier representing the source

Maximum string length: 100

data.source.type

string

required

Type of source

Maximum string length: 100

Get an event using event id Get Togai Metrics

⌘I

Introduction

APIs

​Query Parameters: Allowed filter combinations

Authorizations

Query Parameters

Body

Response

Query Parameters: Allowed filter combinations