> 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/breakdown-user.md).

# By User

Get usage breakdown by user.

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

Returns usage distribution across users.

## Request

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

### 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
[
    {
        "dimension": "user-guid-1",
        "dimensionName": "admin@example.com",
        "requestCount": 5200,
        "totalTokens": 1150000,
        "percentage": 0.31
    },
    {
        "dimension": "user-guid-2",
        "dimensionName": "editor@example.com",
        "requestCount": 4100,
        "totalTokens": 920000,
        "percentage": 0.25
    },
    {
        "dimension": "",
        "dimensionName": "System/API",
        "requestCount": 3580,
        "totalTokens": 485000,
        "percentage": 0.21
    }
]
```

{% endcode %}

## Examples

{% code title="cURL" %}

```bash
curl -X GET "https://your-site.com/umbraco/ai/management/api/v1/analytics/usage-by-user?from=2024-01-01T00:00:00Z&to=2024-01-31T23:59:59Z" \
  -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-by-user?from={from:O}&to={to:O}");

var breakdown = await response.Content.ReadFromJsonAsync<UsageBreakdownItemModel[]>();

foreach (var item in breakdown.OrderByDescending(x => x.RequestCount))
{
    Console.WriteLine($"{item.DimensionName}: {item.RequestCount} requests ({item.Percentage:P0})");
}
```

{% endcode %}

## Response Properties

| Property        | Type   | Description                                 |
| --------------- | ------ | ------------------------------------------- |
| `dimension`     | string | User ID (empty string for system/API calls) |
| `dimensionName` | string | User name (nullable)                        |
| `requestCount`  | int    | Number of requests                          |
| `totalTokens`   | long   | Total tokens used                           |
| `percentage`    | double | Share of total requests (0.0-1.0)           |

## Notes

* An empty `dimension` indicates system or API-initiated requests without a user context
* User information is based on the authenticated user at request time

## Use Cases

* **User activity tracking** - Monitor AI usage by team members
* **Training needs** - Identify power users who could train others
* **Quota management** - Implement per-user usage limits
* **Compliance** - Audit who is using AI features


---

# 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/breakdown-user.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.