Meter an API request

post

https://api.revenium.ai/meter/v2/apis/requests

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The metadata for the API request

transactionId

string

required

A client-supplied unique identifier used to correlate request and response pairs across /meter/v2/apis/requests and /meter/v2/apis/response endpoints. Must be consistent between related API calls to ensure proper usage tracking and analytics.

sourceId

string | null

Sources are typically individual API endpoints. For existing sources, the ID can be found in the Revenium platform on the sources page or retrieved programmatically via the list sources endpoint. A sourceId is created automatically for new sources.

credential

string | null

The credential used to access the API (e.g., API key, OAuth token, or key alias). This identifier maps the API transaction to a specific subscriber and their associated subscription/product for proper usage tracking and billing. Visible on the subscriber credentials page in the Revenium platform. Credentials can be API keys or key aliases depending on your system architecture.

sourceType

string

enum

Defaults to UNKNOWN

Specifies the originating platform or gateway of the metered API traffic. This helps Revenium properly process and categorize incoming metrics according to their source system architecture. If not specified, defaults to 'UNKNOWN'.

method

string | null

enum

The HTTP method of the request

Allowed:

resource

string | null

        Visible in the ‘resource’ field when viewing sources in the revenium application. 
        The resource field (often a full URL or relative URI) can be used to auto-match 
        transactions to existing sources based on the URL/URI accessed in the API call.

contentType

string | null

The content type of the request

remoteHost

string | null

The IP address for the origin of the request. Used by Revenium to report API usage by geography.

userAgent

string | null

The user agent of the request

requestMessageSize

int64 | null

The size of the request message in bytes

Headers

Idempotency-Key

string

length between 1 and 255

^[!-~]+$

Optional Stripe-style retry-safety key. If present, the response (status + body) is cached keyed by (tenant, key). Identical retries replay the cached response; body mismatch returns 409 idempotency_key_mismatch; a concurrent in-flight call returns 409 idempotency_key_in_progress with Retry-After: 1. Must be 1-255 printable ASCII characters; UUID v4 recommended. See https://docs.revenium.io/integrations/idempotency for full behavior.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

201Returns the created metering response object.

400Bad request. Either invalid_idempotency_key from the idempotency filter (canonical envelope), or a controller-level body parse / @Valid failure (legacy ApiError envelope). The two will converge to a single schema once the v2 error envelope unification lands.

401Unauthorized - Authentication required

403Forbidden. The API key scope is not allowed to post to metering endpoints. Use a key with METERING (rev_mk_), WRITE (rev_sk_), or legacy (hak_) scope.

404Resource not found

409Idempotency conflict. idempotency_key_mismatch when the same Idempotency-Key was reused with a different request body. idempotency_key_in_progress when a concurrent request with the same key is still in flight; in that case the response carries a Retry-After header.

413Request body exceeds the maximum size buffered by the idempotency filter.

422Unprocessable entity

429Too Many Requests

500Internal server error

503Idempotency cache backing store is temporarily unavailable. Retry later.