> ## 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 visibility alignment

> Bring mention presence and citation support into one brand assessment.

Bring mention presence and citation support into one brand assessment.

**MCP tool:** `get_visibility_alignment`. **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. |
| `aggregation_level` | string | No | `'bundle'` | Accepts entity or bundle; this edition serves entity-level alignment rows. requested\_aggregation\_level records the request. |
| `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_visibility_alignment",
  "arguments": {
    "project_id": "PROJECT_ID",
    "run_id": "RUN_ID",
    "aggregation_level": "entity",
    "subject": {
      "kind": "self_and_competitors"
    }
  }
}
```

## Read the response

Measurement envelope with entity-level rows, returned metric blocks, and qualitative diagnosis labels. `aggregation_level` describes the served result; `requested_aggregation_level` records the request.

### 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.aggregation_level` | Served reporting unit for the alignment rows. |
| `data.requested_aggregation_level` | Reporting unit requested by the caller. |
| `data.rows[].entity_or_bundle` | Measured name for the alignment assessment. |
| `data.rows[].mention_coverage` | How often responses mention the entity, with its own interval and quality fields. |
| `data.rows[].groundedness` | Citation support for mention statements, with its own interval and quality fields. Its count basis differs from mention coverage. |

## 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": {
    "aggregation_level": "entity",
    "requested_aggregation_level": "entity",
    "rows": [
      {
        "entity_or_bundle": "Colorescience",
        "mention_coverage": {
          "value": 0.2520833333333333,
          "ci": {
            "lower": 0.21041666666666664,
            "upper": 0.29583333333333334,
            "level": 0.95
          },
          "n": 95,
          "n_responses": 480,
          "stability": "stable",
          "stability_n": 480
        },
        "groundedness": {
          "value": 0.365,
          "ci": {
            "lower": 0.295,
            "upper": 0.435,
            "level": 0.95
          },
          "n": 280,
          "stability": "stable",
          "stability_n": 209
        }
      }
    ]
  }
}
```

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

## Important behavior

Preserve the returned diagnosis rather than recreating classification logic. These rows are entity-level even when bundle was requested. Missing grounding data limits the assessment.

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.


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