Delete events by refs

curl --request POST \
  --url https://connect.withvayu.com/events/delete-by-refs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refs": [
    "<string>"
  ]
}
'

{
  "events": [
    {
      "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"
      }
    }
  ]
}

POST

events

delete-by-refs

Delete events by refs

curl --request POST \
  --url https://connect.withvayu.com/events/delete-by-refs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refs": [
    "<string>"
  ]
}
'

{
  "events": [
    {
      "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.

Body

application/json

A list of event refs to delete. The request deletes the matching events for the authenticated account.

refs

string[]

required

Required array length: 1 - 1000 elements

Minimum string length: 1

Response

Contains the events that were removed along with deletion metadata.

events

object[]

required

The events that were deleted

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

string

required

events.createdAt

string<date-time>

required

events.updatedAt

string<date-time>

required

events.deletedAt

string

required

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"
}

Delete an event by refId Retrieve credit ledger entries for customer.

⌘I

API Documentation

API Reference

Delete events by refs

Authorizations

Body

Response