API Reference
Log In
API Reference

Meter an API request

Send this when your API receives a request. Send the matching response to POST /v2/apis/responses with the same transactionId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The metadata for the API request

string
required

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

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.

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.

string
enum
Defaults to UNKNOWN

Names the SDK or gateway that sent this data. Used for reporting only. Defaults to 'UNKNOWN'. The values REVENIUM and INTERNAL are reserved for data Revenium creates itself; do not send them.

string | null
enum

The HTTP method of the request

Allowed:
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.

string | null

The content type of the request

string | null

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

string | null

The user agent of the request

int64 | null

The size of the request message in bytes

Headers
string
length between 1 and 255
^[!-~]+$

Optional key that makes retries safe. Revenium stores the response for each key in your account and replays it if you retry with the same key. Reusing a key with a different request body returns 409 idempotency_key_mismatch; retrying while the first request is still in progress 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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*