# Events ## Overview ### Available Operations * [ingestEvent](#ingestevent) - Ingest event * [getUsageAnalytics](#getusageanalytics) - Get usage analytics * [ingestEventsBulk](#ingesteventsbulk) - Bulk ingest events * [getHuggingfaceInferenceData](#gethuggingfaceinferencedata) - Get Hugging Face inference data * [getEvent](#getevent) - Get event * [listRawEvents](#listrawevents) - List raw events * [getUsageStatistics](#getusagestatistics) - Get usage statistics * [getUsageByMeter](#getusagebymeter) - Get usage by meter ## ingestEvent Use when sending a single usage event from your app (e.g. one API call or one GB stored). Events are processed asynchronously; returns 202 with event_id. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.events.ingestEvent({ customerId: "customer456", eventId: "event123", eventName: "api_request", externalCustomerId: "customer456", properties: { ""response_status"": "200}", "{"request_size"": "100", }, source: "api", timestamp: "2024-03-20T15:04:05Z", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { eventsIngestEvent } from "@flexprice/sdk/funcs/events-ingest-event.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await eventsIngestEvent(flexprice, { customerId: "customer456", eventId: "event123", eventName: "api_request", externalCustomerId: "customer456", properties: { ""response_status"": "200}", "{"request_size"": "100", }, source: "api", timestamp: "2024-03-20T15:04:05Z", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("eventsIngestEvent failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.IngestEventRequest](../../sdk/models/ingest-event-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[{ [k: string]: string }](../../models/.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getUsageAnalytics Use when building analytics views (e.g. usage by feature or customer over time). Supports filtering, grouping, and time-series breakdown. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.events.getUsageAnalytics({}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { eventsGetUsageAnalytics } from "@flexprice/sdk/funcs/events-get-usage-analytics.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await eventsGetUsageAnalytics(flexprice, {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("eventsGetUsageAnalytics failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.GetUsageAnalyticsRequest](../../sdk/models/get-usage-analytics-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetUsageAnalyticsResponse](../../sdk/models/get-usage-analytics-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## ingestEventsBulk Use when batching usage events (e.g. backfill or high-volume ingestion). More efficient than single event calls; returns 202 when accepted. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.events.ingestEventsBulk({ events: [], }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { eventsIngestEventsBulk } from "@flexprice/sdk/funcs/events-ingest-events-bulk.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await eventsIngestEventsBulk(flexprice, { events: [], }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("eventsIngestEventsBulk failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.BulkIngestEventRequest](../../sdk/models/bulk-ingest-event-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[{ [k: string]: string }](../../models/.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getHuggingfaceInferenceData Use when fetching Hugging Face inference usage or billing data (e.g. for HF-specific reporting or reconciliation). Reads the meter-usage pipeline. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.events.getHuggingfaceInferenceData({ requestIds: [ "", "", ], }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { eventsGetHuggingfaceInferenceData } from "@flexprice/sdk/funcs/events-get-huggingface-inference-data.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await eventsGetHuggingfaceInferenceData(flexprice, { requestIds: [ "", "", ], }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("eventsGetHuggingfaceInferenceData failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.GetHuggingFaceBillingDataRequest](../../sdk/models/get-hugging-face-billing-data-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetHuggingFaceBillingDataResponse](../../sdk/models/get-hugging-face-billing-data-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getEvent Use when debugging a specific event (e.g. why it failed or how it was aggregated). Reads the meter-usage pipeline; includes processing status and step-by-step debug tracker when unprocessed. Uses ?id= query param because event IDs can contain "/". ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.events.getEvent(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { eventsGetEvent } from "@flexprice/sdk/funcs/events-get-event.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await eventsGetEvent(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("eventsGetEvent failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Event ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetEventByIDResponse](../../sdk/models/get-event-by-id-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## listRawEvents Use when debugging ingestion or exporting raw event data (e.g. support or audit). Returns a paginated list; supports time range and sorting. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.events.listRawEvents({ endTime: new Date("2024-12-09T00:00:00Z"), order: "desc", sort: "timestamp", startTime: new Date("2024-11-09T00:00:00Z"), }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { eventsListRawEvents } from "@flexprice/sdk/funcs/events-list-raw-events.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await eventsListRawEvents(flexprice, { endTime: new Date("2024-12-09T00:00:00Z"), order: "desc", sort: "timestamp", startTime: new Date("2024-11-09T00:00:00Z"), }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("eventsListRawEvents failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.GetEventsRequest](../../sdk/models/get-events-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetEventsResponse](../../sdk/models/get-events-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getUsageStatistics Use when building usage reports or dashboards across events. Supports filters and grouping; defaults to last 7 days if no range provided. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.events.getUsageStatistics({ aggregationType: "COUNT_UNIQUE", billingAnchor: new Date("2024-03-05T14:30:45.123456789Z"), customerId: "customer456", endTime: new Date("2024-03-20T00:00:00Z"), eventName: "api_request", externalCustomerId: "customer456", propertyName: "request_size", startTime: new Date("2024-03-13T00:00:00Z"), }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { eventsGetUsageStatistics } from "@flexprice/sdk/funcs/events-get-usage-statistics.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await eventsGetUsageStatistics(flexprice, { aggregationType: "COUNT_UNIQUE", billingAnchor: new Date("2024-03-05T14:30:45.123456789Z"), customerId: "customer456", endTime: new Date("2024-03-20T00:00:00Z"), eventName: "api_request", externalCustomerId: "customer456", propertyName: "request_size", startTime: new Date("2024-03-13T00:00:00Z"), }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("eventsGetUsageStatistics failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.GetUsageRequest](../../sdk/models/get-usage-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetUsageResponse](../../sdk/models/get-usage-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getUsageByMeter Use when showing usage for a specific meter (e.g. dashboard or overage check). Supports time range, filters, and grouping by customer or subscription. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.events.getUsageByMeter({ billingAnchor: new Date("2024-03-05T14:30:45Z"), customerId: "customer456", endTime: new Date("2024-12-09T00:00:00Z"), externalCustomerId: "user_5", meterId: "123", startTime: new Date("2024-11-09T00:00:00Z"), }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { eventsGetUsageByMeter } from "@flexprice/sdk/funcs/events-get-usage-by-meter.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await eventsGetUsageByMeter(flexprice, { billingAnchor: new Date("2024-03-05T14:30:45Z"), customerId: "customer456", endTime: new Date("2024-12-09T00:00:00Z"), externalCustomerId: "user_5", meterId: "123", startTime: new Date("2024-11-09T00:00:00Z"), }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("eventsGetUsageByMeter failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.GetUsageByMeterRequest](../../sdk/models/get-usage-by-meter-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetUsageResponse](../../sdk/models/get-usage-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* |