Admin Billing Usage Reports

Get admin usage dimension values

Returns categorical values available for admin usage report filters and grouping controls. When dimensions are omitted, organization_name is included by default alongside useful usage dimensions.

get/api/v1/admin/billing/usage/dimensions

Request

  • Base URL: https://api.sanifu.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.sanifu.ai/api/v1/admin/billing/usage/dimensions
  • Auth: one of:
    • OAuth 2 (password, token URL auth/jwt/login)
    • HTTP basic

Query parameters

preset'mtd' | 'qtd' | 'ytd' | 'last_7d' | 'last_30d' | 'last_90d' | 'last_365d' | 'all_time' | 'custom'

Preset date range for dimension values.

start_datestring date nullable

Inclusive start date. Required when preset=custom.

end_datestring date nullable

Inclusive end date. Required when preset=custom.

dimensionsBillingUsageDimension[] nullable

Dimension lists to return. Omit to return supported dimensions that have at least one non-unknown value. Explicitly requested dimensions are returned even when all values are unknown.

searchstring nullable

Case-insensitive search over dimension labels.

limitinteger

Maximum values to return per requested dimension.

source_typestring[] nullable

Filter by source: execution or builder.

providerstring[] nullable

Filter by provider.

model_namestring[] nullable

Filter by model name.

item_typestring[] nullable

Filter by usage item type.

transaction_typestring[] nullable

Filter by transaction type.

environmentstring[] nullable

Filter by billing environment: production or sandbox.

organization_idinteger[] nullable

Filter by organization ID. Most useful with the admin organization lookup endpoint for unique organization selection.

organization_namestring[] nullable

Filter by organization name. Most useful on admin reports.

agent_namestring[] nullable

Filter by AI/builder agent name, not data app name.

data_app_namestring[] nullable

Filter by data app name.

workflow_namestring[] nullable

Filter by workflow name.

component_namestring[] nullable

Filter by workflow component name.

record_categorystring[] nullable

Filter by record category.

container_slugstring[] nullable

Filter by runtime container tier.

execution_contextstring[] nullable

Filter by execution context.

loop_typestring[] nullable

Filter by loop type.

app_typestring[] nullable

Filter by triggering app type.

integration_patternstring[] nullable

Filter by integration pattern.

Response

Successful Response

dimensionsobject required

Requested dimension values keyed by dimension name.

Example response

{
  "dimensions": {
    "data_app_name": [
      {
        "count": 77,
        "label": "Invoice Processor",
        "total_ai_input_tokens": "482940.0000",
        "total_ai_output_tokens": "93020.0000",
        "total_builder_calls": 9,
        "total_runtime_minutes": "128.3400",
        "total_task_runs": 38,
        "total_task_steps": 214,
        "value": "Invoice Processor"
      }
    ]
  }
}

Changes

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