Delete an event by refId

curl --request DELETE \
  --url https://connect.withvayu.com/events/{refId} \
  --header 'Authorization: Bearer <token>'

{
  "event": {
    "name": "api_call",
    "timestamp": "2023-09-13T18:25:43.511Z",
    "customerAlias": "customer_12345",
    "ref": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "<string>",
    "data": {
      "key1": "processing_duration",
      "key2": "api_url"
    }
  }
}

DELETE

events

{refId}

Delete an event by refId

curl --request DELETE \
  --url https://connect.withvayu.com/events/{refId} \
  --header 'Authorization: Bearer <token>'

{
  "event": {
    "name": "api_call",
    "timestamp": "2023-09-13T18:25:43.511Z",
    "customerAlias": "customer_12345",
    "ref": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "<string>",
    "data": {
      "key1": "processing_duration",
      "key2": "api_url"
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

refId

string

required

Response

Contains the event that was deleted

event

object

required

The event matching the provided refId

Show child attributes

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"

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"

event.customerAlias

string

required

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

Minimum string length: 1

Example:

"customer_12345"

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"

event.id

string

required

event.createdAt

string<date-time>

required

event.updatedAt

string<date-time>

required

event.deletedAt

string

required

event.data

object

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

Show child attributes

event.data.{key}

unknown

Example:

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

Get event by refId Delete events by refs

⌘I

API Documentation

API Reference

Delete an event by refId

Authorizations

Path Parameters

Response