Submit a batch of events for testing

POST

events

dry-run

curl --request POST \
  --url https://connect.withvayu.com/events/dry-run \
  --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"
      }
    }
  ]
}'

{
  "events": [
    {
      "event": {
        "timestamp": "2023-11-07T05:31:56Z",
        "customerAlias": "<string>",
        "accountId": "<string>",
        "data": {},
        "ref": "<string>",
        "name": "<string>"
      },
      "matchedCustomer": "<string>",
      "meterWithValues": [
        {
          "name": "<string>",
          "eventName": "<string>",
          "aggregationMethod": {
            "operator": "Count",
            "field": "<string>",
            "instanceKey": "<string>"
          },
          "filter": {
            "conditions": [
              {
                "criterions": [
                  {
                    "field": "<string>",
                    "operator": "Equals",
                    "value": "<string>"
                  }
                ]
              }
            ]
          },
          "pricing": {
            "pricingModel": "PerUnit",
            "priceConfiguration": {
              "price": 1,
              "chunkSize": 1
            }
          },
          "value": 123,
          "instanceValue": "<any>"
        }
      ]
    }
  ]
}

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

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

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 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 | null

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

Example:

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

Response

200

application/json

Events with their corresponding meter and customer data.

events

object[]

required

events.event

object

required

events.meterWithValues

object[]

required

events.meterWithValues.name

string

required

The name of the meter

Minimum length: 1

events.meterWithValues.eventName

string

required

The name of the event that the meter is tracking.

Minimum length: 1

events.meterWithValues.aggregationMethod

object

required

The aggregation method defines how the events should be summed to represent a usage value.

events.meterWithValues.value

number

required

events.meterWithValues.filter

object

The filter to apply to the events to be included in the meter. The filter object contains an array of Conditions, each condition represents a logical OR statement. Each condition contains an array of Criteria (criterions), each criterion represents a logical AND statement.

events.meterWithValues.pricing

object

The pricing data of the meter. The pricing data contains the pricing model and the pricing details.

events.meterWithValues.instanceValue

any | null

events.matchedCustomer

string | null

curl --request POST \
  --url https://connect.withvayu.com/events/dry-run \
  --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"
      }
    }
  ]
}'

{
  "events": [
    {
      "event": {
        "timestamp": "2023-11-07T05:31:56Z",
        "customerAlias": "<string>",
        "accountId": "<string>",
        "data": {},
        "ref": "<string>",
        "name": "<string>"
      },
      "matchedCustomer": "<string>",
      "meterWithValues": [
        {
          "name": "<string>",
          "eventName": "<string>",
          "aggregationMethod": {
            "operator": "Count",
            "field": "<string>",
            "instanceKey": "<string>"
          },
          "filter": {
            "conditions": [
              {
                "criterions": [
                  {
                    "field": "<string>",
                    "operator": "Equals",
                    "value": "<string>"
                  }
                ]
              }
            ]
          },
          "pricing": {
            "pricingModel": "PerUnit",
            "priceConfiguration": {
              "price": 1,
              "chunkSize": 1
            }
          },
          "value": 123,
          "instanceValue": "<any>"
        }
      ]
    }
  ]
}

API Documentation

API Reference

Submit a batch of events for testing

Authorizations

Body

Response