UsageWorkflowDetail

One sheet's usage in the window, broken down by day, action, error, run, and member.

Properties

summaryobjectrequired

sheet_idstringrequired

namestringrequired

deletedbooleanrequired

total_runsintegerrequired

credits_consumednumberrequired

success_ratenumberrequired

Percentage, 0-100.

cache_hit_ratenumberrequired

Percentage, 0-100.

dailyarray ofrequired

UsageDailyItem

top_actionsarray ofrequired

UsageTopAction

top_errorsarray ofrequired

The most frequent errors in the window.

messagestringrequired

countintegerrequired

last_seenstringrequired

ISO 8601.

recent_runsarray ofrequired

The 20 most recent runs.

run_idstringrequired

Opaque identifier for the run. Use as a key only; the format is not part of the contract.

created_atstringrequired

ISO 8601.

action_namenull | stringrequired

emailstringrequired

The member who ran it.

creditsnumberrequired

statusnull | stringrequired

fulfillment_sourcestringrequired

How the run was answered: `api_call`, `cache_hit`, `user_api_key`, or `force_consumed`.

per_userarray ofrequired

Empty for a key that only sees its own usage.

UsageTopUser

Example

UsageWorkflowDetail example

{
  "summary": {
    "sheet_id": "string",
    "name": "string",
    "deleted": false,
    "total_runs": 0,
    "credits_consumed": 0,
    "success_rate": 0,
    "cache_hit_rate": 0
  },
  "daily": [
    {
      "date": "string",
      "runs": 0,
      "credits": 0,
      "cache_hits": 0
    }
  ],
  "top_actions": [
    {
      "action_name": "string",
      "runs": 0,
      "credits": 0,
      "cache_hits": 0
    }
  ],
  "top_errors": [
    {
      "message": "string",
      "count": 0,
      "last_seen": "string"
    }
  ],
  "recent_runs": [
    {
      "run_id": "string",
      "created_at": "string",
      "action_name": null,
      "email": "string",
      "credits": 0,
      "status": null,
      "fulfillment_source": "string"
    }
  ],
  "per_user": [
    {
      "email": "string",
      "runs": 0,
      "credits": 0
    }
  ]
}