API Reference
Log In
API Reference

List Workspace Metrics

Retrieves workspace metrics grouped by Revenium name for the authenticated user's organization.

Returns paginated workspace-level costs with aggregated usage metrics.

sort: totalCost (default, descending), providers, workspaceId,
workspaceName, percentage, requestCount, totalTokens, imageCount,
creditsApplied. These are the aggregate names, not the response field names, and an
unknown key fails the request with 400. Sort keys are case-sensitive.

A workspace charged in the period with no usage data counts as zero requests, tokens
and images, so it sorts last by any of the three descending and first ascending. The
response still omits token and image counts for these workspaces; request count is zero.

All costs are in USD. Token counts include all token types (input, output, cache).

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

Unique identifier of the team (organization). Format: Revenium hashid (URL-safe encoded string).

string
enum
required

Time period for analytics

Allowed:
string

Filter start date/time in ISO 8601 format.

string

Filter end date/time in ISO 8601 format.

string
enum

Filter results by AI provider. Omit to include all providers.

Allowed:
string
enum

Filter by usage type. Omit to include all types.

Allowed:
string

Narrow results to a single API key id, within the caller's organization. A value that matches nothing returns an empty result, never the organization total.

number
≥ 0

Filter by a starting cost (inclusive).

number
≥ 0

Filter by an ending cost (inclusive).

string

Search query to filter workspaces by name

integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 20

The size of the page to be returned

sort
array of strings
Defaults to totalCost,DESC

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
Headers
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
*/*