veryfront__get_usage_series
Requires account.billing.read.
Access
No external-service connection is required. Use a Veryfront credential with access to the requested resources.
Call type: Read-only.
Arguments
Example request
Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "veryfront__get_usage_series",
"arguments": {
"metric": "credits"
}
}
}Result
The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.
Full schemas
{
"type": "object",
"properties": {
"preset": {
"type": "string",
"enum": [
"7d",
"30d",
"90d"
],
"description": "Whole local days, defaulting to 30d. Explicit from/to bounds take precedence over preset, including SDK-supplied defaults.",
"default": "30d"
},
"from": {
"type": "string",
"format": "date-time",
"description": "Inclusive start. Supply both from and to; these bounds take precedence over preset."
},
"to": {
"$ref": "#/properties/from",
"description": "Exclusive end, no later than the end of today in timezone."
},
"timezone": {
"type": "string",
"description": "Provide the timezone.",
"default": "UTC"
},
"granularity": {
"type": "string",
"enum": [
"hour",
"day",
"week",
"month"
],
"description": "UTC hours, or local calendar days, Monday-based weeks and months.",
"default": "day"
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project",
"model",
"api_key",
"member"
],
"description": "One group by item supplied to the tool."
},
"maxItems": 4,
"description": "Grouping dimensions supported by this operation. Repeat the parameter or use a comma-separated list."
},
"compare": {
"type": "string",
"const": "previous_period",
"description": "Compare preceding calendar months for whole-month custom ranges, local days for whole-day ranges and presets, or equal elapsed duration otherwise."
},
"metric": {
"type": "string",
"enum": [
"credits",
"storage",
"bandwidth",
"api_calls"
],
"description": "Usage metric to chart."
},
"project_reference": {
"type": "string",
"minLength": 1,
"description": "Project ID or slug that narrows the read to one project of the account. A project of another account is not found."
}
},
"required": [
"metric"
],
"additionalProperties": false,
"description": "Arguments for the get_usage_series tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"metric": {
"type": "string",
"enum": [
"credits",
"storage",
"bandwidth",
"api_calls"
]
},
"label": {
"type": "string"
},
"unit": {
"type": "string"
},
"summary": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"previous": {
"type": "object",
"properties": {
"value": {
"type": "number"
}
},
"required": [
"value"
],
"additionalProperties": false
}
},
"required": [
"value"
],
"additionalProperties": false,
"description": "Structured summary details associated with this tool result."
},
"timeframe": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date-time",
"description": "Inclusive start."
},
"to": {
"type": "string",
"format": "date-time",
"description": "Exclusive end."
},
"timezone": {
"type": "string"
},
"granularity": {
"type": "string",
"enum": [
"hour",
"day",
"week",
"month"
]
},
"bucket_count": {
"type": "integer",
"minimum": 0
},
"previous": {
"type": "object",
"properties": {
"from": {
"$ref": "#/properties/timeframe/properties/from",
"description": "The from returned by the tool."
},
"to": {
"$ref": "#/properties/timeframe/properties/to",
"description": "The to returned by the tool."
},
"timezone": {
"$ref": "#/properties/timeframe/properties/timezone",
"description": "The timezone returned by the tool."
},
"granularity": {
"$ref": "#/properties/timeframe/properties/granularity",
"description": "The granularity returned by the tool."
},
"bucket_count": {
"$ref": "#/properties/timeframe/properties/bucket_count",
"description": "The bucket count returned by the tool."
}
},
"required": [
"from",
"to",
"timezone",
"granularity",
"bucket_count"
],
"additionalProperties": false
}
},
"required": [
"from",
"to",
"timezone",
"granularity",
"bucket_count"
],
"additionalProperties": false,
"description": "Structured timeframe details associated with this tool result."
},
"series": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bucket_start": {
"type": "string"
},
"value": {
"type": "number"
},
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"project_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Project identifier associated with this result."
},
{
"type": "null",
"description": "Project identifier associated with this result."
}
],
"description": "Project identifier associated with this result."
},
"project_name": {
"type": "string"
},
"project_slug": {
"type": [
"string",
"null"
]
},
"value": {
"type": "number"
}
},
"required": [
"project_id",
"project_name",
"project_slug",
"value"
],
"additionalProperties": false
},
"description": "List of projects associated with this tool result."
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dimensions": {
"type": "object",
"properties": {
"project_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Project identifier associated with this result."
},
{
"type": "null",
"description": "Project identifier associated with this result."
}
],
"description": "Project identifier associated with this result."
},
"model": {
"type": [
"string",
"null"
],
"description": "AI model id associated with this tool result."
},
"model_provider": {
"type": [
"string",
"null"
]
},
"api_key_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null",
"description": "The api key id returned by the tool."
}
]
},
"api_key_kind": {
"type": "string",
"enum": [
"api_key",
"no_api_key",
"other_keys",
"deleted_keys",
"unattributed"
],
"description": "Key-listing reports distinguish named keys, other/deleted keys, keyless and unattributed usage."
},
"member_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null",
"description": "The member id returned by the tool."
}
]
},
"member_kind": {
"type": "string",
"enum": [
"member",
"former_member",
"deleted_users",
"automations",
"unattributed"
],
"description": "Project-member reports distinguish named people, deleted users, automations and unattributed usage."
}
},
"additionalProperties": false,
"description": "Structured dimensions details associated with this tool result."
},
"value": {
"type": "number"
}
},
"required": [
"dimensions",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"bucket_start",
"value",
"projects"
],
"additionalProperties": false
},
"description": "List of series associated with this tool result."
},
"projects": {
"type": "array",
"items": {
"$ref": "#/properties/series/items/properties/projects/items",
"description": "One project item returned by the tool."
},
"description": "List of projects associated with this tool result."
},
"scope": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "account"
},
"account_id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Project identifier associated with this result."
},
{
"type": "null",
"description": "Project identifier associated with this result."
}
],
"description": "Project identifier associated with this result."
}
},
"required": [
"kind",
"account_id",
"project_id"
],
"additionalProperties": false
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project",
"model",
"api_key",
"member"
]
}
}
},
"required": [
"metric",
"label",
"unit",
"summary",
"timeframe",
"series",
"projects"
],
"additionalProperties": false,
"description": "Structured result returned by the get_usage_series tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}