> For the complete documentation index, see [llms.txt](https://docs.umbraco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbraco.com/ai-in-umbraco/19.latest/management-api/analytics/summary.md).

# Summary

Get aggregated usage summary for a time period.

{% hint style="warning" %}
This endpoint is obsolete and will be removed in version 20. Use [Get Usage Overview](/ai-in-umbraco/19.latest/management-api/analytics/overview.md) instead.
{% endhint %}

Returns aggregated usage statistics for the specified time period.

## Request

{% code title="Endpoint" %}

```http
GET /umbraco/ai/management/api/v1/analytics/usage-summary
```

{% endcode %}

### Query Parameters

| Parameter     | Type     | Required | Description                                                             |
| ------------- | -------- | -------- | ----------------------------------------------------------------------- |
| `from`        | datetime | Yes      | Start of period (inclusive)                                             |
| `to`          | datetime | Yes      | End of period (exclusive)                                               |
| `granularity` | string   | No       | Aggregation granularity: `Hourly` or `Daily` (auto-selected if omitted) |

## Response

### Success

{% code title="200 OK" %}

```json
{
    "totalRequests": 15420,
    "inputTokens": 2450000,
    "outputTokens": 890000,
    "totalTokens": 3340000,
    "successCount": 15210,
    "failureCount": 210,
    "successRate": 0.9864,
    "averageDurationMs": 1245
}
```

{% endcode %}

## Examples

### Last 30 Days Summary

{% code title="cURL" %}

```bash
curl -X GET "https://your-site.com/umbraco/ai/management/api/v1/analytics/usage-summary?from=2024-01-01T00:00:00Z&to=2024-01-31T23:59:59Z" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

{% endcode %}

### With Explicit Granularity

{% code title="cURL" %}

```bash
curl -X GET "https://your-site.com/umbraco/ai/management/api/v1/analytics/usage-summary?from=2024-01-25T00:00:00Z&to=2024-01-26T00:00:00Z&granularity=Hourly" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

{% endcode %}

{% code title="C#" %}

```csharp
var from = DateTime.UtcNow.AddDays(-30);
var to = DateTime.UtcNow;

var response = await httpClient.GetAsync(
    $"/umbraco/ai/management/api/v1/analytics/usage-summary?from={from:O}&to={to:O}");

var summary = await response.Content.ReadFromJsonAsync<UsageSummaryResponseModel>();

Console.WriteLine($"Total Requests: {summary.TotalRequests}");
Console.WriteLine($"Total Tokens: {summary.TotalTokens:N0}");
Console.WriteLine($"Success Rate: {summary.SuccessRate:P1}");
```

{% endcode %}

## Response Properties

| Property            | Type   | Description                            |
| ------------------- | ------ | -------------------------------------- |
| `totalRequests`     | int    | Number of AI operations in the period  |
| `inputTokens`       | long   | Total tokens sent in requests          |
| `outputTokens`      | long   | Total tokens received in responses     |
| `totalTokens`       | long   | Combined input and output tokens       |
| `successCount`      | int    | Number of successful operations        |
| `failureCount`      | int    | Number of failed operations            |
| `successRate`       | double | Success rate (0.0 to 1.0)              |
| `averageDurationMs` | int    | Average operation time in milliseconds |

## Notes

* Token counts are based on values reported by the AI provider
* If no data exists for the period, all values will be 0
* Large date ranges may take longer to compute


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.umbraco.com/ai-in-umbraco/19.latest/management-api/analytics/summary.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.