---
title: "Mentions grouped by one dimension"
description: "One table of matched, relevant and sentiment counts grouped by `by`: platform, keyword, sentiment, intent, status, hour (weekday and hour of day) or person. The window is `range` (7d, 30d, 90d, 365d, ending today) or `from` and `to`, cut into days in `timezone` (UTC by default); `keywordIds` and `platforms` narrow it; `compare=true` adds the period of the same length right before it. Time axis is the publish date."
canonical: https://docs.mentio.dev/api/analytics/get-analytics-breakdown
markdown: https://docs.mentio.dev/api/analytics/get-analytics-breakdown.mdx
---

# Mentions grouped by one dimension

`GET /v1/analytics/breakdown`

One table of matched, relevant and sentiment counts grouped by `by`: platform, keyword, sentiment, intent, status, hour (weekday and hour of day) or person. The window is `range` (7d, 30d, 90d, 365d, ending today) or `from` and `to`, cut into days in `timezone` (UTC by default); `keywordIds` and `platforms` narrow it; `compare=true` adds the period of the same length right before it. Time axis is the publish date.

## Parameters

- `range` (query): Preset window ending today. Ignored when from or to is given. Default 30d.
- `from` (query): First day, YYYY-MM-DD, inclusive, in `timezone`.
- `to` (query): Last day, YYYY-MM-DD, inclusive, in `timezone`. Default today.
- `keywordIds` (query): Only these keyword ids. Repeatable, or comma-separated; omit for every keyword.
- `platforms` (query): Only these platforms. Repeatable, or comma-separated; omit for every platform.
- `compare` (query): true adds the period of the same length right before the window as `previous`.
- `timezone` (query): IANA zone the days are cut in (Europe/Madrid). Default UTC. One offset, the zone's at the end of the window, applies to the whole window.
- `by` (query, required): The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in `timezone`), person (who posted; anonymous posts are left out), language (ISO 639-1; "unknown" for posts without one).

## Responses

- 200: Groups, most matched first
- 400: Invalid query
- 401: Missing or invalid API key

Full schemas: https://api.mentio.dev/v1/openapi.json. Conventions: https://docs.mentio.dev/conventions.mdx