---
title: "Get a mention breakdown"
description: "`by` sets the rows (platform, keyword, sentiment, intent, status, hour as weekday and hour, or person), and each row has matched, relevant and sentiment counts. Pick the period with `range` (7d, 30d, 90d or 365d up to today) or with `from` and `to`. Days follow `timezone`, UTC by default. `keywordIds` and `platforms` narrow the data, and `compare=true` adds the equally long period just before. Dates are publish dates."
canonical: https://docs.rumoro.dev/api/analytics/get-analytics-breakdown
markdown: https://docs.rumoro.dev/api/analytics/get-analytics-breakdown.mdx
---

# Get a mention breakdown

`GET /v1/analytics/breakdown`

`by` sets the rows (platform, keyword, sentiment, intent, status, hour as weekday and hour, or person), and each row has matched, relevant and sentiment counts. Pick the period with `range` (7d, 30d, 90d or 365d up to today) or with `from` and `to`. Days follow `timezone`, UTC by default. `keywordIds` and `platforms` narrow the data, and `compare=true` adds the equally long period just before. Dates are publish dates.

## Parameters

| Name | In | Description |
| --- | --- | --- |
| `range` | query | A preset period up to today, 30d by default. Ignored when you send from or to. |
| `from` | query | Start date in `timezone`, as YYYY-MM-DD. That day is included. |
| `to` | query | End date in `timezone`, as YYYY-MM-DD, included. Defaults to today. |
| `keywordIds` | query | Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords. |
| `platforms` | query | Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms. |
| `compare` | query | true adds the equally long period just before as `previous`. |
| `timezone` | query | The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period. |
| `by` | query, required | How to group the rows. platform, keyword, sentiment (unclassified included), intent (a mention can have several), status (open, ignored, done), hour (weekday and hour in `timezone`), person (the author, without anonymous posts) or language (ISO 639-1, or "unknown" when there is none). |

## Responses

| Status | Meaning |
| --- | --- |
| 200 | The rows, the one with the most matches first |
| 400 | The query is not valid |
| 401 | The API key is missing or not valid |

The [OpenAPI document](https://api.rumoro.dev/v1/openapi.json) has every schema. Rules shared by all endpoints are in [Conventions](https://docs.rumoro.dev/conventions.mdx).