Submit a batch of events for ingestion

curl --request POST \
  --url https://connect.withvayu.com/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "name": "api_call",
      "timestamp": "2023-09-13T18:25:43.511Z",
      "customerAlias": "customer_12345",
      "ref": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
      "data": {
        "key1": "processing_duration",
        "key2": "api_url"
      }
    }
  ]
}
'

{
  "validEvents": [
    {
      "name": "api_call",
      "timestamp": "2023-09-13T18:25:43.511Z",
      "customerAlias": "customer_12345",
      "ref": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
      "data": {
        "key1": "processing_duration",
        "key2": "api_url"
      }
    }
  ],
  "invalidEvents": [
    {
      "event": {
        "name": "api_call",
        "timestamp": "2023-09-13T18:25:43.511Z",
        "customerAlias": "customer_12345",
        "ref": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
        "data": {
          "key1": "processing_duration",
          "key2": "api_url"
        }
      },
      "error": "Event ref already exists."
    }
  ]
}

POST

events

curl --request POST \
  --url https://connect.withvayu.com/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "name": "api_call",
      "timestamp": "2023-09-13T18:25:43.511Z",
      "customerAlias": "customer_12345",
      "ref": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
      "data": {
        "key1": "processing_duration",
        "key2": "api_url"
      }
    }
  ]
}
'

{
  "validEvents": [
    {
      "name": "api_call",
      "timestamp": "2023-09-13T18:25:43.511Z",
      "customerAlias": "customer_12345",
      "ref": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
      "data": {
        "key1": "processing_duration",
        "key2": "api_url"
      }
    }
  ],
  "invalidEvents": [
    {
      "event": {
        "name": "api_call",
        "timestamp": "2023-09-13T18:25:43.511Z",
        "customerAlias": "customer_12345",
        "ref": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
        "data": {
          "key1": "processing_duration",
          "key2": "api_url"
        }
      },
      "error": "Event ref already exists."
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

An array of events following the EventInput schema. This request body should be included in the PUT request to '/events' Up to 1000 events or a total payload max size of 256KB

events

object[]

required

Required array length: 1 - 1000 elements

Show child attributes

events.name

string

required

The distinctive label assigned to an event, serving as a critical identifier for categorizing and pricing events within the system's backend infrastructure.

Example:

"api_call"

events.timestamp

string<date-time>

required

The temporal marker denoting the exact moment of event occurrence. The timestamp is formatted as an ISO 8601 string and is expressed in Coordinated Universal Time (UTC). i.e. YYYY-MM-DDTHH:MM:SS.SSSZ

Example:

"2023-09-13T18:25:43.511Z"

events.customerAlias

string

required

A pseudonymous or otherwise obfuscated identifier uniquely assigned to each customer.

Minimum string length: 1

Example:

"customer_12345"

events.ref

string

required

A universally unique identifier (UUID) or other form of high-entropy string serving as an immutable reference for each event entry.

Example:

"4f6cf35x-2c4y-483z-a0a9-158621f77a21"

events.data

object

A schema-less JSON object encapsulating miscellaneous attributes and metrics associated with the event.

Show child attributes

events.data.{key}

unknown

Example:

{
  "key1": "processing_duration",
  "key2": "api_url"
}

Response

RequestSuccess

validEvents

object[]

required

An array of events that were successfully processed and sent to the queue.

Show child attributes

validEvents.name

string

required

The distinctive label assigned to an event, serving as a critical identifier for categorizing and pricing events within the system's backend infrastructure.

Example:

"api_call"

validEvents.timestamp

string<date-time>

required

The temporal marker denoting the exact moment of event occurrence. The timestamp is formatted as an ISO 8601 string and is expressed in Coordinated Universal Time (UTC). i.e. YYYY-MM-DDTHH:MM:SS.SSSZ

Example:

"2023-09-13T18:25:43.511Z"

validEvents.customerAlias

string

required

A pseudonymous or otherwise obfuscated identifier uniquely assigned to each customer.

Minimum string length: 1

Example:

"customer_12345"

validEvents.ref

string

required

A universally unique identifier (UUID) or other form of high-entropy string serving as an immutable reference for each event entry.

Example:

"4f6cf35x-2c4y-483z-a0a9-158621f77a21"

validEvents.data

object

A schema-less JSON object encapsulating miscellaneous attributes and metrics associated with the event.

Show child attributes

validEvents.data.{key}

unknown

Example:

{
  "key1": "processing_duration",
  "key2": "api_url"
}

invalidEvents

object[]

required

An array of events that failed validation and were not sent to the queue. Each object contains the event and the error message.

Show child attributes

invalidEvents.event

object

required

Show child attributes

invalidEvents.event.name

string

required

The distinctive label assigned to an event, serving as a critical identifier for categorizing and pricing events within the system's backend infrastructure.

Example:

"api_call"

invalidEvents.event.timestamp

string<date-time>

required

The temporal marker denoting the exact moment of event occurrence. The timestamp is formatted as an ISO 8601 string and is expressed in Coordinated Universal Time (UTC). i.e. YYYY-MM-DDTHH:MM:SS.SSSZ

Example:

"2023-09-13T18:25:43.511Z"

invalidEvents.event.customerAlias

string

required

A pseudonymous or otherwise obfuscated identifier uniquely assigned to each customer.

Minimum string length: 1

Example:

"customer_12345"

invalidEvents.event.ref

string

required

A universally unique identifier (UUID) or other form of high-entropy string serving as an immutable reference for each event entry.

Example:

"4f6cf35x-2c4y-483z-a0a9-158621f77a21"

invalidEvents.event.data

object

A schema-less JSON object encapsulating miscellaneous attributes and metrics associated with the event.

Show child attributes

invalidEvents.event.data.{key}

unknown

Example:

{
  "key1": "processing_duration",
  "key2": "api_url"
}

invalidEvents.error

string

required

The error message indicating the reason the event failed validation.

Example:

"Event ref already exists."

Query events by timestamp period and optional event name Get event by refId

⌘I

API Documentation

API Reference

Submit a batch of events for ingestion

Authorizations

Body

Response