UsageWorkflowRow

Usage for one sheet. A workflow's sheets are separate rows sharing a `workflow_id` — sum them for the workflow total. Field names match the Sheet schema: `sheet_id` is this row, `workflow_id` is the workflow it belongs to.

Properties

sheet_idstringrequired

UUID of the sheet. Pass to Get Workflow Usage, and as `{sheet_id}` on every sheet-scoped workflow endpoint.

namestringrequired

Fully qualified name, `Parent > Sheet` for a child sheet.

deletedbooleanrequired

True when the workflow has since been deleted.

workflow_idstringrequired

UUID of the parent workflow this sheet belongs to — the `{workflow_id}` of the workflow endpoints. Equals `sheet_id` on a main sheet.

workflow_namestringrequired

The parent workflow's name.

sheet_namestringrequired

This sheet's own label — `Main Sheet` for an unnamed main sheet — without the parent prefix.

is_main_sheetbooleanrequired

runsintegerrequired

creditsnumberrequired

success_countintegerrequired

Runs that succeeded.

cache_hitsintegerrequired

cache_hit_ratenumberrequired

Percentage of runs served from cache, 0-100.

top_actionsarray ofrequired

The three actions that spent the most credits in this sheet.

UsageTopAction

Example

UsageWorkflowRow example

{
  "sheet_id": "string",
  "name": "string",
  "deleted": false,
  "workflow_id": "string",
  "workflow_name": "string",
  "sheet_name": "string",
  "is_main_sheet": false,
  "runs": 0,
  "credits": 0,
  "success_count": 0,
  "cache_hits": 0,
  "cache_hit_rate": 0,
  "top_actions": [
    {
      "action_name": "string",
      "runs": 0,
      "credits": 0,
      "cache_hits": 0
    }
  ]
}