Skip to content

UsageQueryRequest

The time range and filters every /usage call takes. Every filter is optional; filters combine with AND across parameters and OR within one. A parameter may be repeated, and each value may also be comma-separated, except agent, provider, model, engine and tier, whose values are taken whole. At most 50 values per parameter. The value ~none matches “no value” for that dimension.

Kind: an object, used in requests.

FieldTypeRequiredDescription
fromstring | nullThe start of the range: ISO 8601 with an offset, rounded down to the hour (UTC). Default: to minus 7 days.
tostring | nullThe end of the range: ISO 8601 with an offset, rounded up to the hour (UTC). Default: the start of the next hour.
namespacestring[] | nullNamespace names, matched as GET /processes matches them. The name a deleted or renamed namespace had also matches.
typestring[] | nullKinds of run: Interaction, App, Capsule or CodePipeline (case-insensitive).
definitionIdstring[] | nullIds of the definitions (interactions, apps, capsules, code pipelines) whose runs to include.
versionstring[] | nullDefinition versions, as {definitionId}:{version}.
agentstring[] | nullAgent names: the interaction or code pipeline agents whose turns or steps used the tokens.
providerstring[] | nullThe AI providers that served interaction turns, such as Anthropic.
modelstring[] | nullModel names.
enginestring[] | nullCode pipeline engines, as CodeEngineType names.
credentialKindstring[] | nullWhose provider key served the tokens: Own (the tenant’s or the run’s own key), Platform (Maitento’s) or Unknown (none was recorded).
tierstring[] | nullPricing tiers, for models whose price depends on how many tokens a request uses.
outcomestring[] | nullHow the runs ended: InProgress, Finished, Error or Killed.
startedBystring[] | nullWhat started the runs: User, Automation or Parent.
triggerIdstring[] | nullIds of the users or automations that started the runs.
rootDefinitionIdstring[] | nullDefinition ids of the runs at the top of the tree: everything an app (or any top-level run) caused, the runs it started included.
{
"from": "...",
"to": "...",
"namespace": [
"..."
],
"type": [
"..."
],
"definitionId": [
"..."
],
"version": [
"..."
],
"agent": [
"..."
],
"provider": [
"..."
],
"model": [
"..."
],
"engine": [
"..."
],
"credentialKind": [
"..."
],
"tier": [
"..."
],
"outcome": [
"..."
],
"startedBy": [
"..."
],
"triggerId": [
"..."
],
"rootDefinitionId": [
"..."
]
}