> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get usage series

> Chart one usage metric of an account by day, optionally for one project; returns the daily series with a total and a per-project breakdown.

`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

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `metric` | `string` | Yes | Usage metric to chart. Values: `"credits"`, `"storage"`, `"bandwidth"`, `"api_calls"`. |
| `preset` | `string` | No | Provide the preset. Default: `"30d"`. Values: `"7d"`, `"30d"`, `"90d"`. |
| `timezone` | `string` | No | Provide the timezone. Default: `"UTC"`. |
| `project_reference` | `string` | No | Project ID or slug that narrows the read to one project of the account. A project of another account is not found. Minimum length: `1`. |

## 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](https://veryfront.com/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "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.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `metric` | `string` | Yes | Values: `"credits"`, `"storage"`, `"bandwidth"`, `"api_calls"`. |
| `label` | `string` | Yes | |
| `unit` | `string` | Yes | |
| `summary` | `object` | Yes | Structured summary details associated with this tool result. |
| `timeframe` | `object` | Yes | Structured timeframe details associated with this tool result. |
| `series` | `object[]` | Yes | List of series associated with this tool result. |
| `projects` | `object[]` | Yes | List of projects associated with this tool result. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "metric": {
      "type": "string",
      "enum": [
        "credits",
        "storage",
        "bandwidth",
        "api_calls"
      ],
      "description": "Usage metric to chart."
    },
    "preset": {
      "type": "string",
      "enum": [
        "7d",
        "30d",
        "90d"
      ],
      "description": "Provide the preset.",
      "default": "30d"
    },
    "timezone": {
      "type": "string",
      "description": "Provide the timezone.",
      "default": "UTC"
    },
    "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#"
}
```

```json title="output-schema.json" theme={null}
{
  "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"
        }
      },
      "required": [
        "value"
      ],
      "additionalProperties": false,
      "description": "Structured summary details associated with this tool result."
    },
    "timeframe": {
      "type": "object",
      "properties": {
        "from": {
          "type": "string"
        },
        "to": {
          "type": "string"
        },
        "granularity": {
          "type": "string",
          "const": "day"
        },
        "timezone": {
          "type": "string"
        },
        "bucket_count": {
          "type": "number"
        }
      },
      "required": [
        "from",
        "to",
        "granularity",
        "timezone",
        "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."
          }
        },
        "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."
    }
  },
  "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#"
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__get_usage_series` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.