> ## 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 sentiment

> Read positive, negative, neutral, or net sentiment for scored entities.

Read positive, negative, neutral, or net sentiment for scored entities.

**MCP tool:** `get_sentiment`. **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 | `'positive'` | positive, negative, or neutral selects that sentiment rate; net selects the signed balance of positive and negative sentiment. |
| `aggregation_level` | string | No | `'entity'` | Accepts entity or bundle, but this edition returns entity-level sentiment rows for either value. A bundle request does not combine names. |
| `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_sentiment",
  "arguments": {
    "project_id": "PROJECT_ID",
    "run_id": "RUN_ID",
    "metric": "net",
    "aggregation_level": "entity",
    "subject": {
      "kind": "self_and_competitors"
    }
  }
}
```

## Read the response

Measurement envelope with scored rows and estimates. Inspect `subject_summary.unscored_entities` and warnings for requested names without sentiment results.

### 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.metric` | Sentiment rate or signed net score requested. |
| `data.rows[].entity_or_bundle` | The name whose sentiment was scored. |
| `data.rows[].estimate` | Returned sentiment value, interval, and row quality. Keep the interval even when the value appears strongly positive or negative. |
| `data.rows[].n_classified_mentions` | Classified mention count attached to the sentiment row. |
| `data.rows[].n_unclassified_mentions` | Unclassified count returned by this response. Do not infer it from the sum of the three exposed sentiment rates. |

## 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": "net",
    "aggregation_level": "entity",
    "rows": [
      {
        "entity_or_bundle": "Color Science",
        "group_by_values": {},
        "estimate": {
          "value": 1,
          "ci": {
            "lower": -0.96,
            "upper": 1,
            "level": 0.95
          },
          "n": 1,
          "stability": "insufficient",
          "stability_n": 1
        },
        "n_classified_mentions": 1,
        "n_unclassified_mentions": 0
      }
    ]
  }
}
```

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

## Important behavior

Class rates use proportions; net sentiment is signed. A measured mention does not guarantee a sentiment score exists for that entity. Missing sentiment is not neutral sentiment.

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 sentiment](/developers/http/http-get-sentiment). HTTP parameters and defaults can differ.


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