AgentGetUnitConsumptionSummaryOptions
Options for getting the agent unit consumption summary.
Currently identical to AgentGetSummaryOptions (the API uses the same
AgentsSummaryRequest schema for both endpoints); named distinctly so that
future per-method filters can be added without a breaking change.
Extends¶
Properties¶
| Property | Type | Description |
|---|---|---|
agentId? |
string |
Filter to a single agent by ID. |
agentNames? |
string[] |
Filter to specific agent names. |
executionType? |
AgentExecutionType |
Filter to a specific execution type — Debug (test runs) or Runtime (production runs). |
folderKey? |
string |
Filter to a specific folder by key (GUID). The summary endpoint accepts both — folderKey selects a single folder, folderKeys filters the lookup to a list of folders. |
folderKeys? |
string[] |
Optional folder keys to scope the lookup. Intersected with the user's accessible folders. |
lookbackPeriodAnalysis? |
boolean |
When true, it also computes a lookbackPeriodSummary for the prior window of equal length. Defaults to false server-side. Default false |
processKey? |
string |
Filter to a specific process by key (GUID). |
processVersion? |
string |
Filter to a specific process version. |
projectKeys? |
string[] |
Filter to specific project keys. |