> For the complete documentation index, see [llms.txt](https://docs.edgetag.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgetag.io/mcp/tools/domain-analytics.md).

# domainAnalytics

The primary tool for event counts and traffic analysis. Use this for questions like "how many purchases today?", "what's the traffic breakdown?", or "how many errors last week?".

This should be the first tool used for any analytics question. For drilling down into specific channels or events, follow up with `domainAnalyticsProvider` or `domainAnalyticsEvent`.

### Parameters

| Parameter   | Type          | Required | Description                                                                                            |
| ----------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| `domainId`  | string (UUID) | Yes      | The domain ID (tagId). Get this from the `domains` tool.                                               |
| `teamId`    | string (UUID) | Yes      | The team ID the domain belongs to.                                                                     |
| `type`      | enum          | Yes      | What to group by: `status` (success/error counts), `name` (by event name), or `provider` (by channel). |
| `range`     | number        | Yes      | Number of time units to look back.                                                                     |
| `rangeType` | enum          | Yes      | Time unit: `MINUTE`, `HOUR`, or `DAY`.                                                                 |
| `status`    | number        | Yes      | Filter by status: `1` for successful events, `0` for errors.                                           |
| `timezone`  | string        | Yes      | IANA timezone, e.g., `America/New_York`.                                                               |

### Output

Returns time-series data with event counts grouped by the selected type. Each data point includes a timestamp and count.

### Examples

> "How many purchases did we have today?"

Uses `type: "name"`, `range: 24`, `rangeType: "HOUR"`, `status: 1`.

> "Show me the traffic breakdown by channel for the last 7 days"

Uses `type: "provider"`, `range: 7`, `rangeType: "DAY"`, `status: 1`.

> "How many errors in the last hour?"

Uses `type: "status"`, `range: 60`, `rangeType: "MINUTE"`, `status: 0`.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.edgetag.io/mcp/tools/domain-analytics.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.