Billing - Usage

Get usage metrics

Get usage metrics for the workspace

get/billing/usage/metrics

Request

  • Base URL
    https://api.getcargo.io/v1
  • URL
    https://api.getcargo.io/v1/billing/usage/metrics
  • Auth
    HTTP bearer

Query parameters

workflowUuidstring uuid

Filter metrics by workflow identifier.

modelUuidstring uuid

Filter metrics by model identifier.

connectorUuidstring uuid

Filter metrics by connector identifier.

integrationSlugstring

Filter metrics by integration slug.

slugstring

Filter metrics by slug.

agentUuidstring uuid

Filter metrics by agent identifier.

fromstring required

Start of the time range.

tostring required

End of the time range.

groupBy'integration_slug' | 'connector_uuid' | 'model_uuid' | 'workflow_uuid' | 'agent_uuid'

Group metrics by this dimension.

unit'billing.credits' | 'storage.records' | 'orchestration.executions'

Usage unit to report.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.