Report usage events

Reports raw usage events for event-based metering. Events are ingested asynchronously and aggregated into usage totals.

POST /api/v1/events

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1.events.report({
  events: [
    {
      customerId: 'customerId',
      eventName: 'x',
      idempotencyKey: 'x',
    },
  ],
});

console.log(response.data);

200

{
  "data": {}
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID · string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

Report raw usage events. Batch up to 1000 events with dimensions.

events · ReportEvent · object[] · required

A list of usage events to report

Required array length: 1 - 1000 elements

Show child attributes

Response

200

application/json

Confirmation that events were accepted for processing.

Response object

data · EventResponse · object · required

Empty success response confirming that events were successfully ingested and queued for processing by Stigg's metering system.