Documentation Index
Fetch the complete documentation index at: https://guide.withvayu.com/llms.txt
Use this file to discover all available pages before exploring further.
Use the events query endpoint to retrieve ingested events by time range, filter by event name or customer, and paginate through large datasets.
Endpoint: GET /events
Query parameters
| Parameter | Type | Required | Description |
|---|
startTime | string | Yes | Start of the time range (ISO 8601 UTC) |
endTime | string | Yes | End of the time range (ISO 8601 UTC) |
eventName | string | No | Filter to a specific event type |
customerAlias | string | No | Filter to events for a specific customer alias |
limit | number | No | Results per page (default: 10, max: 1,000) |
cursor | string | No | Pagination cursor from the previous response |
Response
Returns a paginated response with an events array.
{
"events": [
{
"name": "api_call",
"ref": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"customerAlias": "customer-123",
"timestamp": "2026-01-15T14:30:00Z",
"data": {
"endpoint": "/v1/predict",
"tokens": 1500
}
}
],
"total": 4821,
"hasMore": true,
"nextCursor": "eyJpZCI6IjEyMyJ9"
}
Examples
# Basic query by time range
curl "https://connect.withvayu.com/events?startTime=2026-01-01T00:00:00Z&endTime=2026-01-31T23:59:59Z&limit=100" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-api-key: $VAYU_CLIENT_ID"
# Filter by event name and customer
curl "https://connect.withvayu.com/events?startTime=2026-01-01T00:00:00Z&endTime=2026-01-31T23:59:59Z&eventName=api_call&customerAlias=customer-123" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-api-key: $VAYU_CLIENT_ID"
Via the UI
Navigate to Usage → Events in the left sidebar to view the latest 100 events. You can filter by date range, event name, customer alias, or reference ID directly in the interface.
