> For the complete documentation index, see [llms.txt](https://docs.avis.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.avis.net/guide/console/usage-query.md).

# Usage Query

**Usage Query** lets you look up exactly how your API was used, broken down by API key, product type, and date range. Use it to investigate a spending spike, check a specific integration, or prepare a cost report.

Open it from **Usage Query** in the Console sidebar.

***

## Run a query

**Step 1:** Choose a product type from the tabs at the top:

* **Video Generation**
* **Image Generation**
* **Audio Generation**
* **Text Generation**
* **Embedding Generation**
* **Video Tool**

**Step 2:** In **API Keys**, choose **All keys** or a single key.

**Step 3:** In **Select Time Range**, pick a start and end date. The default is the last 7 days.

**Step 4:** Read the results:

* **Overall Overview** shows **Total Requests**, **Successful Tasks**, and **Total Cost (Credits)** for your selection.
* **Query Analysis** shows the detailed breakdown, including generated outputs and concurrency over time.

**Note:** If you see **No data found**, there was no usage of that product type for that key and date range. Try another tab or a wider date range.

***

## Dashboard or Usage Query?

| Use the **Dashboard** when you want to… | Use **Usage Query** when you want to…         |
| --------------------------------------- | --------------------------------------------- |
| See total spending at a glance          | Investigate one key or one product type       |
| Compare models                          | Check successful tasks against total requests |
| Split Playground and API usage          | Look at a specific custom date range          |

To pull usage records into your own tools, use `GET /api/compat/v1/usage`. See [Usage](/api-reference/introduction/use.md).


---

# 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.avis.net/guide/console/usage-query.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.