Skip to content

AgentGetTopConsumptionOptions

Options for getting the top agents by consumption.

Extends

Properties

Property Type Description
agentId? string Filter to a single agent by ID.
agentNames? string[] Filter to specific agent names.
agentTypes? AgentType[] Filter to specific agent types. Multiple types are combined with OR and sent to the API as a comma-separated string.
folderKeys? string[] Optional folder keys to scope the lookup. Intersected with the user's accessible folders.
healthThreshold? number Health-score cutoff used when healthy is set. Defaults to 75.0 server-side. Default 75.0
healthy? boolean Health-based filter. true returns only healthy agents, false only unhealthy. Omit to include both.
limit? number Max number of agents to return. Defaults to 10 server-side. Default 10
processVersion? string Filter to a specific process version.
projectKeys? string[] Filter to specific project keys.