API docs by Redocly

Usage Engine Cloud Edition API

Download OpenAPI specification:Download

Usage Engine offers several different APIs for performing various tasks using external systems.

HTTP error response codes

Describes the standard HTTP error codes returned by the API, including their meanings and typical scenarios.

The following error response codes are used in the system:

Error code Explanation
400 Bad request
401 Unauthorized
404 Not found
405 Method not allowed
409 Conflict
413 Request body too large
429 Too many requests
500 An unexpected internal error occurred even though the request was valid
503 Service unavailable

Authentication

Endpoints for obtaining OAuth 2.0 tokens to securely access the API.

Create access token

Generates a bearer access token for authenticating OAuth clients with the Usage Engine REST API. Requires an Application Access client ID and secret. See Application Access for setup instructions.

Rate Limits
Each client can make up to 1000 requests every 5m. The burst capacity is 1000 requests.

header Parameters
Content-Type
string
Authorization
string
Request Body schema: application/json

Credentials used for authenticating the client to the authorization server.

audience
required
string

The intended recipients which should accept and process the token. Use the base URL for the environment you are accessing.

client_id
required
string

The client ID generated when creating the Application Access in Usage Engine CE.

client_secret
required
string

The client secret generated when creating the Application Access in Usage Engine CE.

grant_type
required
string

The OAuth grant type that will be used to generate the token. The value of this parameter must be client_credentials.

Responses

Request samples

Content type
application/json
{
  • "audience": "https://api.digitalroute.io/",
  • "client_id": "u4grtTy18E2DYANsv0G174aSxR3EeOiA",
  • "client_secret": "U6qN9NTgis3MLeleRXtLgIxtRE-qhpZcPJ_5eoNtNQYcodiY9q0Abs3afgpbX3M6",
  • "grant_type": "client_credentials"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZUYU5saGpnclFERE0xYkdVZG1WeiJ9.eyJhY2NvdW50SWQiOiJhZDZmZWM5NS1lMDYzLTQ5MmItOTJjYy01MmJiNjJjMGU3NTAiLCJpc3MiOiJodHRwczovL2F1dGguZGlnaXRhbHJvdXRlLmlvLyIsInN1YiI6IjhtMUhUMHA2SkdMOVJjbzhWNEZjWGZ2Y2dHejcwcms4QGNsaWVudHMiLCJhdWQiOiJodHRwczovL2FwaS5kaWdpdGFscm91dGUuaW8vIiwiaWF0IjoxNzEyMTQ0OTQzLCJleHAiOjE3MTIxNDg1NDMsInNjb3BlIjoiY3JlYXRlOm1ldGVyX3R5cGVzIGNyZWF0ZTptZXRlcnMgZGVsZXRlOm1ldGVyX3R5cGVzIGRlbGV0ZTptZXRlcnMgcmVhZDptZXRlcl90eXBlcyByZWFkOm1ldGVycyB1cGRhdGU6bWV0ZXJfdHlwZXMiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJhenAiOiI4bTFIVDBwNkpHTDlSY284VjRGY1hmdmNnR3o3MHJrOCJ9.VS8Ti1zTK4b8qGRKXJg8b0-aMpNpTTL1_nwsPbCeM7CFlUYu45ZUQGWvUqC6XGK-Xl3j9k5Tkth8TtFbbXNEW4mEV0e1qQbDu_ZlvH-bH2nCNJhk-7mFriGYfTF0U-erqNiMsk4Tbrmm2Voy9CJ4_WyVrCjTLBqRBKb_bU4KHFJtgadlqwaTVNZUiI-sIV3Y2V_gid_4qPTO1Vr01ybID_F8uNII9goDqPJBRh6hmcKHqt65U5n2xzbmBcNqRPoXqxh1g9OaYEPDjojp2lHttqs2EkGG9KxzTFqhdX4lcrjfHGgzNk7LD7S7mGJTO0V-n57geptxM7gFGr-hAQ4Ikg",
  • "expires_in": 3600,
  • "scope": "create:meter_types create:meters delete:meter_types delete:meters read:meter_types read:meters update:meter_types",
  • "token_type": "Bearer"
}

Meter type

Defines categories for usage-based billing, representing products or services available to customers.

List meter types

Returns all meter types configured for your account.

Rate Limits
Each client can make up to 5000 requests every 5m. The burst capacity is 100 requests.

Authorizations:
OAuth 2.0 Bearer Token
query Parameters
limit
string

Defines the number of meter types to be returned. A maximum of 100 items can be returned.

skip
string

Defines an offset for the meter types to be returned. If you set skip to 10, the first 10 meter types will be skipped in the returned list.

sortOrder
string

Determines the sort order of the returned list; ASC for ascending or DESC for descending.

sortBy
string

Determines the field in the meter type by which the returned list will be sorted.

name
string

Defines the name for which meter type should be returned. You may provide full or partial name.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "meterTypes": [
    ]
}

Create meter type

Creates a new meter type in your account.

Rate Limits
Each client can make up to 5000 requests every 5m. The burst capacity is 100 requests.

Authorizations:
OAuth 2.0 Bearer Token
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
activeFrom
string

Determines from which date and time the meter type will be active, with the time based on UTC. The date and time cannot be in the past, and if this parameter is left undefined, the current date and time will be picked.

activeTo
string

Determines to which date and time the meter type will be active, with the time based on UTC. The date and time cannot be in the past, and if this parameter is left undefined, it will be active indefinitely.

required
object

Choose the aggregation type for aggregating data within a defined interval.

  • Sum: Summarize all values.
  • Increment: Count the number of occurrences.
  • Max: Highest value received.
  • Min: Lowest value received.

The aggregation type cannot be updated.

capacity
number >= 0

The total capacity allocated for meters of this meter type. This value serves as a reference of upper limit for each meter of this type.

category
string <= 50 characters

Specify the category to which the meter type should be assigned. By using the category when configuring the Meter processor, meter types can be added, edited, or deleted without necessarily affecting the Meter processor configuration. If no category is specified, the meter type will be assigned to the DEFAULT category.

description
string <= 200 characters

You can add a more detailed description for the meter type with this parameter.

externalRef
string <= 100 characters

If the meter type is registered as a product in an external system, you can add the external ID to reference it.

name
required
string <= 80 characters ^[\w\s().-]+$

Name of the meter type. Only alphanumeric characters, spaces, and the following special characters are supported - _ . ( )

required
object

Determines how often the usage counting data should be reset and sent to downstream systems defined in crontab format.

Array of Using absolute value (object) or Using percentage of capacity (object) <= 5 items

A list of one or more thresholds that define usage checkpoints for meters of this meter type. When meter value reaches the defined threshold, a signal or action can be triggered.

timezone
required
string

The canonical timezone that should be applied for reset time. See IANA time zones for the complete available list.

unit
required
string <= 50 characters

State the unit which the meters should be measuring, such as MB, minutes, etc.

Responses

Request samples

Content type
application/json
{
  • "activeFrom": "2023-07-26T09:00:15.690+00:00",
  • "activeTo": "2024-11-22T00:00:00.000+00:00",
  • "aggregation": {
    },
  • "capacity": 1000,
  • "category": "API Counts",
  • "description": "Meter definition to count the number of API requests per customer",
  • "externalRef": "878752b4-4ddf",
  • "name": "Usage based API counter",
  • "resetSchedule": {
    },
  • "thresholds": [
    ],
  • "timezone": "Etc/UTC",
  • "unit": "requests"
}

Response samples

Content type
application/json
{
  • "accountId": "4d6548c8-1793-498f-9306-9ec101cb9bf8",
  • "activeFrom": "2023-07-26T09:00:15.690+00:00",
  • "activeTo": "2024-11-22T00:00:00.000+00:00",
  • "aggregation": {
    },
  • "capacity": 1000,
  • "category": "API Counts",
  • "createdAt": "2023-07-26T09:00:15.690+00:00",
  • "description": "Meter definition to count the number of API requests per customer",
  • "externalRef": "878752b4-4ddf",
  • "id": "645ed240-02b5-400c-9a3c-21857e8f2ac4",
  • "name": "Usage based API counter",
  • "numberOfMeters": 0,
  • "resetSchedule": {
    },
  • "thresholds": [
    ],
  • "timezone": "Etc/UTC",
  • "unit": "requests",
  • "updatedAt": "2023-07-26T09:00:15.690+00:00"
}

Delete meter type

Deletes the specified meter type. It is not allowed to delete meter type with associated meters. You must delete associated meters first to delete meter type.

Rate Limits
Each client can make up to 5000 requests every 5m. The burst capacity is 100 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The unique ID of meter type.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 1
}

Get meter type

Retrieves details for a specific meter type by its unique identifier.

Rate Limits
Each client can make up to 5000 requests every 5m. The burst capacity is 100 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The unique ID of meter type.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "accountId": "4d6548c8-1793-498f-9306-9ec101cb9bf8",
  • "activeFrom": "2023-07-26T09:00:15.690+00:00",
  • "activeTo": "2024-11-22T00:00:00.000+00:00",
  • "aggregation": {
    },
  • "capacity": 1000,
  • "category": "API Counts",
  • "createdAt": "2023-07-26T09:00:15.690+00:00",
  • "description": "Meter definition to count the number of API requests per customer",
  • "externalRef": "878752b4-4ddf",
  • "id": "645ed240-02b5-400c-9a3c-21857e8f2ac4",
  • "name": "Usage based API counter",
  • "numberOfMeters": 0,
  • "resetSchedule": {
    },
  • "thresholds": [
    ],
  • "timezone": "Etc/UTC",
  • "unit": "requests",
  • "updatedAt": "2023-07-26T09:00:15.690+00:00"
}

Update meter type

Updates the properties of a specified meter type.

Rate Limits
Each client can make up to 5000 requests every 5m. The burst capacity is 100 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The unique ID of meter type.

header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
string or null

The new active from date you want the meter type to use.

string or null

The new active to date you want the meter type to use.

capacity
number >= 0

A new total capacity allocated for meters of this meter type.

string or null <= 50 characters

The new category you want the meter type to use. You may need to revise the configuration in the Meter processor following the category update.

description
string <= 200 characters

The updated description you want the meter type to have.

string or null <= 100 characters

The new external ID you want to associate with the meter type.

name
string <= 80 characters ^[\w\s().-]+$

The new name you want the meter type to have. Only alphanumeric characters, spaces, and the following special characters are supported - _ . ( ).

object

The new reset schedule you want the meter type to use. The new reset schedule takes effect after the current period has ended and meters have been reset.

Array of Using absolute value (object) or Using percentage of capacity (object) <= 5 items

A new list of threshold objects, each of which can specify either an absolute value or a percentage of capacity.

timezone
string

The new canonical timezone you want the meter type to use. See IANA time zones for the complete available list.

unit
string <= 50 characters

State the unit which the meters should be measuring, such as MB, minutes, etc.

Responses

Request samples

Content type
application/json
{
  • "activeFrom": "2023-07-26T09:00:15.690+00:00",
  • "activeTo": "2024-11-22T00:00:00.000+00:00",
  • "capacity": 1000,
  • "category": "API Counts",
  • "description": "Meter definition to count the number of API requests per customer",
  • "externalRef": "878752b4-4ddf",
  • "name": "Usage based API counter",
  • "resetSchedule": {
    },
  • "thresholds": [
    ],
  • "timezone": "Etc/UTC",
  • "unit": "requests"
}

Response samples

Content type
application/json
{
  • "accountId": "4d6548c8-1793-498f-9306-9ec101cb9bf8",
  • "activeFrom": "2023-07-26T09:00:15.690+00:00",
  • "activeTo": "2024-11-22T00:00:00.000+00:00",
  • "aggregation": {
    },
  • "capacity": 1000,
  • "category": "API Counts",
  • "createdAt": "2023-07-26T09:00:15.690+00:00",
  • "description": "Meter definition to count the number of API requests per customer",
  • "externalRef": "878752b4-4ddf",
  • "id": "645ed240-02b5-400c-9a3c-21857e8f2ac4",
  • "name": "Usage based API counter",
  • "numberOfMeters": 0,
  • "resetSchedule": {
    },
  • "thresholds": [
    ],
  • "timezone": "Etc/UTC",
  • "unit": "requests",
  • "updatedAt": "2023-07-26T09:00:15.690+00:00"
}

Meter

Represents a customer-specific usage counter, mapping usage events to one or more meter types.

List meters

Retrieves all meters configured for your account.

Rate Limits
Each client can make up to 10000 requests every 5m. The burst capacity is 10000 requests.

Authorizations:
OAuth 2.0 Bearer Token
query Parameters
limit
string

Defines the number of meters to be returned. A maximum of 100 items can be returned.

skip
string

Defines an offset for the meters to be returned. If you set skip to 10, the first 10 meters will be skipped in the returned list.

meterKey
string

Defines the meter key for which meters should be returned.

meterTypeId
string

Defines the meter type ID for which meters should be returned.

userId
string

Defines the user ID for which meters should be returned.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "meters": [
    ]
}

Create meter

Creates a new meter for tracking customer usage.

Rate Limits
Each client can make up to 10000 requests every 5m. The burst capacity is 10000 requests.

Authorizations:
OAuth 2.0 Bearer Token
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
One of
object

Custom fields to enrich the metered output.

meterKey
required
string <= 36 characters

The meter key for the Meter processor counting the usage for the meter.

meterTypeId
required
string <= 36 characters

The unique ID of the meter type that the meter should count usage for.

userId
required
string <= 320 characters

Unique ID of the user the meter belongs to, for example an email address, user name or MSISDN number.

Responses

Request samples

Content type
application/json
Example
{
  • "customFields": {
    },
  • "meterKey": "a1f8797b-c827-4483-b6cf-6d3d3baa18a7",
  • "meterTypeId": "645ed240-02b5-400c-9a3c-21857e8f2ac4",
  • "userId": "user0@example.com"
}

Response samples

Content type
application/json
{
  • "capacity": 1000,
  • "carryFirst": {
    },
  • "carryLast": {
    },
  • "createdAt": "2023-07-01T00:00:00.000Z",
  • "customFields": {
    },
  • "deleteOnReset": false,
  • "groupBreakdowns": [
    ],
  • "groups": [
    ],
  • "id": "8a76066d-ff29-417c-a18e-abde22e44310",
  • "meterKey": "a1f8797b-c827-4483-b6cf-6d3d3baa18a7",
  • "meterMetaData": {
    },
  • "meterTypeId": "645ed240-02b5-400c-9a3c-21857e8f2ac4",
  • "meterTypeName": "Usage based API counter",
  • "periodEnd": "2023-08-01T00:00:00.000Z",
  • "periodStart": "2023-07-01T00:00:00.000Z",
  • "thresholds": [
    ],
  • "timezone": "Etc/UTC",
  • "unit": "requests",
  • "updatedAt": "2023-07-05T22:01:04.431Z",
  • "userId": "user0@example.com",
  • "value": 25
}

Delete meter

Deletes the specified meter from your account.

Rate Limits
Each client can make up to 10000 requests every 5m. The burst capacity is 10000 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The unique ID of meter.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 1
}

Get meter

Retrieves details for a specific meter by its unique identifier.

Rate Limits
Each client can make up to 10000 requests every 5m. The burst capacity is 10000 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The unique ID of meter.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "capacity": 1000,
  • "carryFirst": {
    },
  • "carryLast": {
    },
  • "createdAt": "2023-07-01T00:00:00.000Z",
  • "customFields": {
    },
  • "deleteOnReset": false,
  • "groupBreakdowns": [
    ],
  • "groups": [
    ],
  • "id": "8a76066d-ff29-417c-a18e-abde22e44310",
  • "meterKey": "a1f8797b-c827-4483-b6cf-6d3d3baa18a7",
  • "meterMetaData": {
    },
  • "meterTypeId": "645ed240-02b5-400c-9a3c-21857e8f2ac4",
  • "meterTypeName": "Usage based API counter",
  • "periodEnd": "2023-08-01T00:00:00.000Z",
  • "periodStart": "2023-07-01T00:00:00.000Z",
  • "thresholds": [
    ],
  • "timezone": "Etc/UTC",
  • "unit": "requests",
  • "updatedAt": "2023-07-05T22:01:04.431Z",
  • "userId": "user0@example.com",
  • "value": 25
}

Update meter

Updates the properties of a specified meter.

Rate Limits
Each client can make up to 10000 requests every 5m. The burst capacity is 10000 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The unique ID of meter.

header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
capacity
number >= 0

The new total capacity allocated to this meter after the update, representing reference of usage limit. This value is used as the reference for evaluating capacityPercentage thresholds for this meter.

object

Custom fields to enrich the metered output.

deleteOnReset
boolean

Determine whether the meter should be deleted after the next reset.

Array of Using absolute value (object) or Using percentage of capacity (object) <= 5 items

A new list of threshold objects, each of which can specify either an absolute value or a percentage of capacity.

Responses

Request samples

Content type
application/json
{
  • "capacity": 1000,
  • "customFields": {
    },
  • "deleteOnReset": true,
  • "thresholds": [
    ]
}

Response samples

Content type
application/json
{
  • "capacity": 1000,
  • "carryFirst": {
    },
  • "carryLast": {
    },
  • "createdAt": "2023-07-01T00:00:00.000Z",
  • "customFields": {
    },
  • "deleteOnReset": false,
  • "groupBreakdowns": [
    ],
  • "groups": [
    ],
  • "id": "8a76066d-ff29-417c-a18e-abde22e44310",
  • "meterKey": "a1f8797b-c827-4483-b6cf-6d3d3baa18a7",
  • "meterMetaData": {
    },
  • "meterTypeId": "645ed240-02b5-400c-9a3c-21857e8f2ac4",
  • "meterTypeName": "Usage based API counter",
  • "periodEnd": "2023-08-01T00:00:00.000Z",
  • "periodStart": "2023-07-01T00:00:00.000Z",
  • "thresholds": [
    ],
  • "timezone": "Etc/UTC",
  • "unit": "requests",
  • "updatedAt": "2023-07-05T22:01:04.431Z",
  • "userId": "user0@example.com",
  • "value": 25
}

Online collection

Endpoints for managing collectors and submitting usage data to online storage.

List collectors

Retrieves a paginated and sortable list of collectors associated with your account.

Rate Limits
Each client can make up to 1000 requests every 5m. The burst capacity is 100 requests.

Authorizations:
OAuth 2.0 Bearer Token
query Parameters
limit
integer

Defines the number of collectors to be returned. A maximum of 100 items can be returned.

skip
integer

Defines an offset for the collectors to be returned. If you set skip to 10, the first 10 collectors will be skipped in the returned list.

sortOrder
string
Enum: "ASC" "DESC"

Determines the sort order of the returned list.

sortBy
string
Enum: "name" "status" "createdAt" "updatedAt"

Determines the field in the collector by which the returned list will be sorted.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "collectors": [
    ],
  • "limit": 25,
  • "skip": 0,
  • "total": 150
}

Create collector

Creates a new collector for your account. Each account may have up to five collectors.

Rate Limits
Each client can make up to 5 requests every 5s. The burst capacity is 1 requests.

Authorizations:
OAuth 2.0 Bearer Token
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "Example collector 1"
}

Response samples

Content type
application/json
{
  • "createdAt": "2023-07-01T00:00:00.000Z",
  • "id": "8a76066d-ff29-417c-a18e-abde22e44310",
  • "name": "Collector Name",
  • "status": "ACTIVE",
  • "updatedAt": "2023-07-05T22:01:04.431Z"
}

Delete collector

Removes the specified collector from your account.

Rate Limits
Each client can make up to 5 requests every 5s. The burst capacity is 1 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The collector ID. A unique ID used to group and store all usage records.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 1
}

Get collector

Retrieves details for a specific collector by its unique identifier.

Rate Limits
Each client can make up to 1000 requests every 5m. The burst capacity is 100 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The collector ID. A unique ID used to group and store all usage records.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2023-07-01T00:00:00.000Z",
  • "id": "8a76066d-ff29-417c-a18e-abde22e44310",
  • "name": "Collector Name",
  • "status": "ACTIVE",
  • "updatedAt": "2023-07-05T22:01:04.431Z"
}

Update collector

Updates the specified collector's properties. Only the name field can be modified.

Rate Limits
Each client can make up to 5 requests every 5s. The burst capacity is 1 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The collector ID. A unique ID used to group and store all usage records.

header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
non-empty
name
string [ 1 .. 50 ] characters

The new name for the collector

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Collector Name"
}

Response samples

Content type
application/json
{
  • "createdAt": "2023-07-01T00:00:00.000Z",
  • "id": "8a76066d-ff29-417c-a18e-abde22e44310",
  • "name": "Collector Name",
  • "status": "ACTIVE",
  • "updatedAt": "2023-07-05T22:01:04.431Z"
}

Send data

Submits usage records to the online collection storage for the specified collector.

Rate Limits
Each client can make up to 300000 requests every 5m. The burst capacity is 1000 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The collector ID. A unique ID used to group and store all usage records.

header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
required
string or object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "ingestionId": "645ed240-02b5-400c-9a3c-21857e8f2ac4"
}

Stream management

Endpoints for managing and exporting stream configurations.

Export stream

Exports the complete configuration of a stream, including all nodes (instantiated functions), edges (data flows), node groups, and optional annotations.

Rate Limits
Each client can make up to 5000 requests every 5m. The burst capacity is 100 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The unique identifier of the stream to export.

query Parameters
tag
string

A version tag that identifies which version of the stream configuration to export. If not provided, the latest version will be returned.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "annotation": {
    },
  • "description": "Initial draft version",
  • "edges": [
    ],
  • "name": "My Stream",
  • "nodeGroups": [
    ],
  • "nodes": [
    ],
  • "tag": "v1.0"
}

List stream versions

Retrieves a list of all available versions for a specific stream.

Rate Limits
Each client can make up to 5000 requests every 5m. The burst capacity is 100 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The unique identifier of the stream.

query Parameters
skip
integer

The number of stream versions to skip before starting to return results. Use for pagination.

limit
integer

The maximum number of stream versions to return. Use for pagination. The maximum allowed value is 100.

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ]
}

Aggregation

Endpoints for managing aggregation sessions.

Lookup script aggregation session

Retrieves a session by calculating its session key from the provided fieldValues, which must be in the same order as the fields defined in your Script aggregator configuration. This endpoint enables direct lookup of a session in the specified aggregation store without pagination.

How it works:
The API uses the values you provide (in the correct order) to generate a unique session key, just like your script aggregation function does. It then looks up and returns the session that matches this key.

Tip: Before using this endpoint, make sure your values match the field order in your Script aggregator function configuration.

Rate Limits
Each client can make up to 10000 requests every 5m. The burst capacity is 1000 requests.

Authorizations:
OAuth 2.0 Bearer Token
path Parameters
id
required
string

The unique identifier of the aggregation store in which to search for the session. Required to scope the lookup to the correct store.

query Parameters
fieldValues
required
string

Array of values, in the same order as the fields defined in your script aggregation function configuration, used to generate the session key. Example: fieldValues=customer123&fieldValues=order456

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2025-10-27T14:04:31.648Z",
  • "data": {
    },
  • "meta": {
    },
  • "timeoutAt": "2025-10-28T16:00:17.645Z",
  • "updatedAt": "2025-10-27T16:00:17.809Z"
}