Get an event using event id - Togai documentation

Authorizations

Authorization

string

headerrequired

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

Path Parameters

event_id

string

required

Response

200 - application/json

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.eventPayload.schemaName

string

required

Name of the Event Schema. Know more about event schema

events.eventPayload.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

events.eventPayload.timestamp

string

required

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

events.eventPayload.accountId

string

required

The event will be associated with the provided account

events.eventPayload.attributes

object[]

required

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

events.eventPayload.attributes.name

string

required

Name of the event attribute

events.eventPayload.attributes.value

string

required

Value of the event attribute

events.eventPayload.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.

events.eventPayload.dimensions

object

required

Dimensions are tags/labels associated with the events.

events.ingestionStatus

object

required

Status about the event ingestion.

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

events.ingestionStatus.statusDescription

string

events.customerId

string

The associated account belongs to this customer

events.source

object

Source of ingestion of event

events.source.id

string

required

Unique identifier representing the source

events.source.type

string

required

Type of source

events.createdAt

string

required

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

events.eventPipelineInfo

object

required

Information related to ingestion of an event

events.eventPipelineInfo.eventSchema

object

events.eventPipelineInfo.eventSchema.name

string

required

events.eventPipelineInfo.eventSchema.version

integer

required

events.eventPipelineInfo.usageMeters

object[]

events.eventPipelineInfo.usageMeters.id

string

required

events.eventPipelineInfo.usageMeters.name

string

required

events.eventPipelineInfo.usageMeters.version

integer

required

events.eventPipelineInfo.usageMeters.status

enum<string>

required

Available options:

PROCESSED_FILTERED_OUT,

PROCESSED_UNITS_COMPUTED

events.eventPipelineInfo.usageMeters.units

number

events.eventPipelineInfo.pricePlans

object[]

events.eventPipelineInfo.pricePlans.name

string

required

events.eventPipelineInfo.pricePlans.id

string

required

events.eventPipelineInfo.pricePlans.scheduleId

string

required

events.eventPipelineInfo.pricePlans.cycleStart

string

required

events.eventPipelineInfo.pricePlans.cycleEnd

string

required

events.eventPipelineInfo.pricePlans.usageMeters

string[]

events.eventPipelineInfo.account

object

events.eventPipelineInfo.account.id

string

required

events.eventPipelineInfo.account.name

string

required

events.eventPipelineInfo.account.alias

string

events.eventPipelineInfo.customer

object

events.eventPipelineInfo.customer.id

string

required

events.eventPipelineInfo.customer.name

string

required

events.eventPipelineInfo.featureDetails

object

events.eventPipelineInfo.featureDetails.featureId

string

required

events.eventPipelineInfo.featureDetails.mappedAttribute

string

required

events.eventPipelineInfo.featureDetails.overageInCycle

number

events.eventPipelineInfo.featureDetails.overageInEvent

number

events.eventPipelineInfo.enrichments

object

events.eventPipelineInfo.enrichments.attributes

object[]

events.eventPipelineInfo.enrichments.attributes.name

string

required

events.eventPipelineInfo.enrichments.attributes.type

enum<string>

required

Available options:

ATTRIBUTE,

DIMENSION

events.eventPipelineInfo.enrichments.attributes.value

string

required

events.eventPipelineInfo.enrichments.dimensions

object[]

events.eventPipelineInfo.enrichments.dimensions.name

string

required

events.eventPipelineInfo.enrichments.dimensions.type

enum<string>

required

Available options:

ATTRIBUTE,

DIMENSION

events.eventPipelineInfo.enrichments.dimensions.value

string

required

events.eventPipelineInfo.enrichments.dependencies

object[]

events.eventPipelineInfo.enrichments.dependencies.key

string

required

events.eventPipelineInfo.enrichments.dependencies.type

enum<string>

required

Available options:

SETTING

events.eventPipelineInfo.enrichments.dependencies.name

string

events.eventPipelineInfo.enrichments.dependencies.value

string

required

events.eventPipelineInfo.revenueDetails

object[]

events.eventPipelineInfo.revenueDetails.usageMeterId

string

required

events.eventPipelineInfo.revenueDetails.revenueBaseCurrency

number

required

events.eventPipelineInfo.revenueDetails.revenueInvoiceCurrency

number

required

events.eventPipelineInfo.statusBeforeReverting

string

Introduction

APIs

Authorizations

Path Parameters

Response