Events

List events

List events

Required scopes: api_events:read

Example (curl):

curl 'https://api.yardstick.team/v1/events?limit=20' \
  -H 'Authorization: Bearer ys_sk_live_…'

Example (TypeScript):

await fetch("https://api.yardstick.team/v1/events?limit=20", {
  headers: { Authorization: `Bearer ${process.env.YS_API_KEY}` },
}).then((r) => r.json());
get/v1/events

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/events
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size (1-100, default 20).

starting_afterstring

Cursor: id of the last record from the previous page.

typestring

Repeatable; restricts to events whose type is in the set (max 50).

created[gte]string date-time

ISO-8601 UTC; only events at or after this time.

created[lte]string date-time

ISO-8601 UTC; only events at or before this time.

Headers

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Response

Success

object'list' required
has_moreboolean required

Changes

No recorded changes to this operation across all 2 revisions of this API.