Read sentiment — HTTP

Read positive, negative, neutral, or net sentiment for scored entities. Method: GET Path: /projects/{project_id}/runs/{run_id}/sentiment Use the HTTP base for your authorized environment and an Authorization: Bearer header. See authentication and HTTP setup.

Parameters

This table covers the standard read profile. It excludes internal application routes and advanced analysis controls.

Name	Location	Type	Required	Default	Meaning
`project_id`	path	string	Yes	—	Project ID from list_projects. Select the project in the intended workspace and environment.
`run_id`	path	string	Yes	—	Run ID from list_runs for this project. Use the exact returned value and check readiness before reading measurements.
`metric`	query	string	No	`"net"`	positive, negative, or neutral selects that sentiment rate; net selects the signed balance of positive and negative sentiment.
`aggregation_level`	query	string	No	`"bundle"`	Accepts entity or bundle, but this edition returns entity-level sentiment rows for either value. A bundle request does not combine names.
`group_by`	query	string	No	`null`	JSON-encoded array. 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`	query	string	No	`null`	JSON-encoded array. 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`	query	string	No	`null`	JSON-encoded object. 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.

Request example

Set IQRUSH_API_BASE and IQRUSH_ACCESS_TOKEN through secure configuration. Replace project/run IDs and sample selections with values returned by your account. JSON objects and arrays are encoded as query strings.

curl --fail-with-body --silent --show-error --get \
  --header "Authorization: Bearer ${IQRUSH_ACCESS_TOKEN}" \
  --header "Accept: application/json" \
  --data-urlencode metric=net \
  --data-urlencode aggregation_level=entity \
  --data-urlencode 'subject={"kind":"self_and_competitors"}' \
  "${IQRUSH_API_BASE%/}/projects/${IQRUSH_PROJECT_ID}/runs/${IQRUSH_RUN_ID}/sentiment"

Read the response

Measurement envelope with scored rows and estimates. Inspect subject_summary.unscored_entities and warnings for requested names without sentiment results. 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.

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.

Selected response fields from IQRush Dev. Lists are shortened and project/run IDs are placeholders; this is not the full response.

{
  "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. MCP equivalent: get_sentiment. Use the parameters and defaults on this page for HTTP.

If the result is unavailable

Check HTTP status and the response’s error field before using data. A successful empty response does not establish a zero value. Preserve not_available, not_available_reason, unavailable_reason, and linked where returned. Errors and recovery shows observed examples.

Get started

Connect securely

Read measurements

Build dependable integrations

Build reports

Report recipes

Reference

Session and discovery

Visibility measurements

Sources and evidence

Changes and trends

Google data

Pages and report planning

HTTP operations

Read sentiment — HTTP

Parameters

Request example

Read the response

Fields to use

If the result is unavailable

​Parameters

​Request example

​Read the response

​Fields to use

​If the result is unavailable

Parameters

Request example

Read the response

Fields to use

If the result is unavailable