Read an executive summary — HTTP

Retrieve a broader set of summary measurements for a report. Method: GET Path: /projects/{project_id}/runs/{run_id}/executive-summary 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.

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" \
  "${IQRUSH_API_BASE%/}/projects/${IQRUSH_PROJECT_ID}/runs/${IQRUSH_RUN_ID}/executive-summary"

Read the response

Top-level fields include headline_metrics, own_domain, citations_breakdown, mentions_breakdown, and top_cited_domains; there is no data wrapper. Despite its name, top_cited_domains contains URL target records in this edition. Preserve value, unit, and ci on estimate objects, and check unavailable reasons. The brand mention breakdown combines the configured terms as a response union, so it can differ from one entity row in get_mention_score. It is not the sum of alias coverage values. The summary is a data response, not a finished report file; request stability separately.

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
`headline_metrics.citation_share`	Headline estimate with unit and interval.
`headline_metrics.citation_coverage`	Headline coverage estimate with unit and interval.
`top_cited_domains[].url`	Cited page URL. Despite the parent field’s name, these entries are URL records.
`top_cited_domains[].citation_share`	Estimate for that page, with its own unit and interval.

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

{
  "data_ready": true,
  "headline_metrics": {
    "citation_share": {
      "value": 0.027000000000000003,
      "unit": "proportion",
      "ci": {
        "lower": 0.019,
        "upper": 0.034,
        "level": 0.95
      },
      "n": null,
      "stability": null
    },
    "citation_coverage": {
      "value": 0.162,
      "unit": "proportion",
      "ci": {
        "lower": 0.131,
        "upper": 0.19399999999999998,
        "level": 0.95
      },
      "n": null,
      "stability": null
    }
  },
  "top_cited_domains": [
    {
      "url": "https://www.aad.org/public/everyday-care/sun-protection/shade-clothing-sunscreen/choosing-right-sunscreen",
      "citation_share": {
        "value": 0.03,
        "unit": "proportion",
        "ci": {
          "lower": 0.02,
          "upper": 0.04,
          "level": 0.95
        },
        "n": null,
        "stability": null
      }
    }
  ]
}

Read the actual returned scope, counts, and interval levels before interpreting these fields. MCP equivalent: get_executive_summary. 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 an executive summary — 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