UsageOverview

Usage totals for the requested window, with the daily trend and the top consumers.

Properties

summaryobjectrequired

total_runsintegerrequired

Action runs in the window.

credits_consumednumberrequired

Credits spent in the window.

success_ratenumberrequired

Percentage of runs that succeeded, 0-100.

cache_savingsnumberrequired

Credits NOT spent because a run was served from cache. Not part of `credits_consumed`.

avg_cost_per_runnumberrequired

`credits_consumed / total_runs`.

active_usersinteger

Members who ran something. Omitted for a key that only sees its own usage.

dailyarray ofrequired

UsageDailyItem

top_workflowsarray ofrequired

UsageTopWorkflow

top_actionsarray ofrequired

UsageTopAction

top_usersarray ofrequired

Empty for a key that only sees its own usage.

UsageTopUser

top_errornull | objectrequired

The most frequent error in the window, or null when nothing failed.

Example

UsageOverview example

{
  "summary": {
    "total_runs": 0,
    "credits_consumed": 0,
    "success_rate": 0,
    "cache_savings": 0,
    "avg_cost_per_run": 0,
    "active_users": 0
  },
  "daily": [
    {
      "date": "string",
      "runs": 0,
      "credits": 0,
      "cache_hits": 0
    }
  ],
  "top_workflows": [
    {
      "sheet_id": "string",
      "name": "string",
      "deleted": false,
      "runs": 0,
      "credits": 0
    }
  ],
  "top_actions": [
    {
      "action_name": "string",
      "runs": 0,
      "credits": 0,
      "cache_hits": 0
    }
  ],
  "top_users": [
    {
      "email": "string",
      "runs": 0,
      "credits": 0
    }
  ],
  "top_error": null
}