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);import os
from stigg import Stigg
client = Stigg(
api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted
)
response = client.v1.events.report(
events=[{
"customer_id": "customerId",
"event_name": "x",
"idempotency_key": "x",
}],
)
print(response.data)package main
import (
"context"
"fmt"
"github.com/stiggio/stigg-go"
"github.com/stiggio/stigg-go/option"
)
func main() {
client := stigg.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.V1.Events.Report(context.TODO(), stigg.V1EventReportParams{
Events: []stigg.V1EventReportParamsEvent{{
CustomerID: "customerId",
EventName: "x",
IdempotencyKey: "x",
}},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}package io.stigg.example;
import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.events.EventReportParams;
import io.stigg.models.v1.events.EventReportResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
StiggClient client = StiggOkHttpClient.fromEnv();
EventReportParams params = EventReportParams.builder()
.addEvent(EventReportParams.Event.builder()
.customerId("customerId")
.eventName("x")
.idempotencyKey("x")
.build())
.build();
EventReportResponse response = client.v1().events().report(params);
}
}require "stigg"
stigg = Stigg::Client.new(api_key: "My API Key")
response = stigg.v1.events.report(events: [{customerId: "customerId", eventName: "x", idempotencyKey: "x"}])
puts(response)using System;
using System.Collections.Generic;
using Stigg.Client;
using Stigg.Client.Models.V1.Events;
StiggClient client = new();
EventReportParams parameters = new()
{
Events =
[
new()
{
CustomerID = "customerId",
EventName = "x",
IdempotencyKey = "x",
Dimensions = new Dictionary<string, Dimension>()
{
{ "foo", "string" }
},
ResourceID = "resourceId",
Timestamp = DateTimeOffset.Parse("2019-12-27T18:11:19.117Z"),
},
],
};
var response = await client.V1.Events.Report(parameters);
Console.WriteLine(response);stigg v1:events report \
--api-key 'My API Key' \
--event '{customerId: customerId, eventName: x, idempotencyKey: x}'curl --request POST \
--url https://api.stigg.io/api/v1/events \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"events": [
{
"eventName": "<string>",
"customerId": "<string>",
"idempotencyKey": "<string>",
"resourceId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"dimensions": {}
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stigg.io/api/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
[
'eventName' => '<string>',
'customerId' => '<string>',
'idempotencyKey' => '<string>',
'resourceId' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z',
'dimensions' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {}
}{
"message": "<string>"
}{
"message": "<string>",
"code": "Unauthenticated"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"code": "RateLimitExceeded"
}Report Events
Reports raw usage events for event-based metering. Events are ingested asynchronously and aggregated into usage totals.
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);import os
from stigg import Stigg
client = Stigg(
api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted
)
response = client.v1.events.report(
events=[{
"customer_id": "customerId",
"event_name": "x",
"idempotency_key": "x",
}],
)
print(response.data)package main
import (
"context"
"fmt"
"github.com/stiggio/stigg-go"
"github.com/stiggio/stigg-go/option"
)
func main() {
client := stigg.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.V1.Events.Report(context.TODO(), stigg.V1EventReportParams{
Events: []stigg.V1EventReportParamsEvent{{
CustomerID: "customerId",
EventName: "x",
IdempotencyKey: "x",
}},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}package io.stigg.example;
import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.events.EventReportParams;
import io.stigg.models.v1.events.EventReportResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
StiggClient client = StiggOkHttpClient.fromEnv();
EventReportParams params = EventReportParams.builder()
.addEvent(EventReportParams.Event.builder()
.customerId("customerId")
.eventName("x")
.idempotencyKey("x")
.build())
.build();
EventReportResponse response = client.v1().events().report(params);
}
}require "stigg"
stigg = Stigg::Client.new(api_key: "My API Key")
response = stigg.v1.events.report(events: [{customerId: "customerId", eventName: "x", idempotencyKey: "x"}])
puts(response)using System;
using System.Collections.Generic;
using Stigg.Client;
using Stigg.Client.Models.V1.Events;
StiggClient client = new();
EventReportParams parameters = new()
{
Events =
[
new()
{
CustomerID = "customerId",
EventName = "x",
IdempotencyKey = "x",
Dimensions = new Dictionary<string, Dimension>()
{
{ "foo", "string" }
},
ResourceID = "resourceId",
Timestamp = DateTimeOffset.Parse("2019-12-27T18:11:19.117Z"),
},
],
};
var response = await client.V1.Events.Report(parameters);
Console.WriteLine(response);stigg v1:events report \
--api-key 'My API Key' \
--event '{customerId: customerId, eventName: x, idempotencyKey: x}'curl --request POST \
--url https://api.stigg.io/api/v1/events \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"events": [
{
"eventName": "<string>",
"customerId": "<string>",
"idempotencyKey": "<string>",
"resourceId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"dimensions": {}
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stigg.io/api/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
[
'eventName' => '<string>',
'customerId' => '<string>',
'idempotencyKey' => '<string>',
'resourceId' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z',
'dimensions' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {}
}{
"message": "<string>"
}{
"message": "<string>",
"code": "Unauthenticated"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"code": "RateLimitExceeded"
}Authorizations
Server API Key
Headers
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
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
Report raw usage events. Batch up to 1000 events with dimensions.
A list of usage events to report
1 - 1000 elementsShow child attributes
Show child attributes
Response
Confirmation that events were accepted for processing.
Response object
Empty success response confirming that events were successfully ingested and queued for processing by Stigg's metering system.
