> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iqrush.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Read mention scores

> Read how often an entity is named, or its recorded mention count.

Read how often an entity is named, or its recorded mention count.

**MCP tool:** `get_mention_score`. **Operation:** read. Uses the authorized connection; no project or content changes are made by this tool.

## Parameters

| Name | Type | Required | Default | Meaning and accepted values |
| - | - | - | - | - |
| `project_id` | string | Yes | `Required` | Project ID from list\_projects. Select the project in the intended workspace and environment. |
| `run_id` | string | Yes | `Required` | Run ID from list\_runs for this project. Use the exact returned value and check readiness before reading measurements. |
| `metric` | string | No | `'coverage'` | coverage requests how often responses mention the entity; count requests mention occurrences. Coverage is a proportion; count is a tally. |
| `aggregation_level` | string | No | `'entity'` | entity selects individual measured names; bundle requests configured brand groupings. Coverage is served at entity level even when bundle is requested; read served\_aggregation\_level. |
| `group_by` | string\[] or null | No | `null` | Split results into rows by the requested dimensions. Check both filters\_applied.group\_by and each row’s group\_by\_values before labeling the groups. |
| `filters` | object\[] or null | No | `null` | Select measured answers with objects containing dimension and values. Use labels from list\_dimension\_options; inspect returned warnings for filters that were not applied. |
| `subject` | string or object or null | No | `null` | Choose brands with kind: leaderboard, all, self, self\_and\_competitors, or specified. For specified, provide entities\_or\_bundles. An unmeasured name is not a measured zero. |

## Example call

Replace ID placeholders and example selections with values from your account. This is the `params` object for MCP `tools/call`.

```json theme={null}
{
  "name": "get_mention_score",
  "arguments": {
    "project_id": "PROJECT_ID",
    "run_id": "RUN_ID",
    "metric": "coverage",
    "aggregation_level": "entity",
    "subject": {
      "kind": "specified",
      "entities_or_bundles": [
        "Colorescience"
      ]
    },
    "group_by": [
      "platform"
    ]
  }
}
```

## Read the response

Measurement envelope with `data.metric`, `data.rows`, and `data.served_aggregation_level` when supplied. Rows include `entity_or_bundle`, `group_by_values`, `estimate`, and brand flags.

### Fields to use

These selected fields explain the example and the result to preserve. Field presence depends on the response; this is not a complete response schema.

| Field | Meaning and use |
| - | - |
| `data.served_aggregation_level` | Reporting unit actually served. It can differ from the requested bundle grouping for coverage. |
| `data.rows[].entity_or_bundle` | Measured name or grouping represented by this row. |
| `data.rows[].estimate.value` | Mention coverage as a proportion, or mention count as a tally, according to data.metric. |
| `data.rows[].estimate.n_responses` | Response count provided for coverage; do not substitute estimate.n as a universal denominator. |
| `data.rows[].estimate.stability` | Row quality. It does not replace the run-level convergence result. |
| `data.filters_applied.warnings` | Requested scope or data limitations to retain with the result. |

## Response example

Selected fields from an observed IQRush Dev response. Lists are shortened and project/run IDs are placeholders. Omitted fields remain available in the actual response.

```json theme={null}
{
  "data_ready": true,
  "data": {
    "metric": "coverage",
    "aggregation_level": "entity",
    "served_aggregation_level": "entity",
    "rows": [
      {
        "entity_or_bundle": "Colorescience",
        "group_by_values": {
          "platform": "VERTEX"
        },
        "estimate": {
          "value": 0.39166666666666666,
          "ci": {
            "lower": 0.3320830242376262,
            "upper": 0.4546636584163782,
            "level": 0.95
          },
          "n": 94,
          "n_responses": 240,
          "stability": "stable",
          "stability_n": 240
        }
      }
    ],
    "filters_applied": {
      "filters": {},
      "group_by": [
        "platform"
      ],
      "warnings": []
    }
  }
}
```

Read the actual returned scope, counts, and interval levels before interpreting these fields.

## Important behavior

Coverage requested at bundle level is served at entity level in this edition. Do not sum alias coverage. Counts can carry confidence intervals; keep any interval returned even if an older tool description says otherwise.

Check tool and payload errors before using the result. [Response handling](/developers/guides/09-responses-and-metrics) explains estimates and empty results; [errors and recovery](/developers/guides/13-errors) covers invalid requests and temporary failures.

HTTP equivalent: [Read mention scores](/developers/http/http-get-mention-score). HTTP parameters and defaults can differ.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.