Skip to main content
POST
/
events
/
record
JavaScript
import Limitry from '@limitry/sdk';

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

const response = await client.events.record({ customerId: 'x', eventType: 'x' });

console.log(response.id);
{
  "id": "<string>",
  "recorded": true
}

Authorizations

Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Body

application/json
customerId
string
required

Customer ID

Minimum string length: 1
eventType
string
required

Event type

Minimum string length: 1
values
object

Numeric values

dimensions
object

Dimensions

properties
object

Additional properties

timestamp
string<date-time>

Event timestamp

Response

Event recorded

id
string
required

ID of the recorded event

recorded
boolean
required

Whether successfully recorded