Compare source overlap — HTTP

Compare the sources that support your brand and competitors. Method: GET Path: /projects/{project_id}/runs/{run_id}/compare-grounding-sources 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.
`brand_set`	query	string	No	`null`	JSON-encoded array. Brand labels whose supporting sources you want to compare. Omit to use the configured target brand and competitors.
`aggregation_level`	query	string	No	`"domain"`	domain requests source-domain results; url requests individual-page results. Keep the same reporting unit when comparing measurements.
`sentiment_filter`	query	string	No	`"any"`	Restrict grounding evidence to positive, negative, or neutral sentiment; any leaves sentiment unrestricted.
`top_per_brand`	query	integer	No	`25`	Maximum leading sources selected for each brand before classifying shared and brand-specific sources. A source outside this selection is not proven absent. Minimum 1. Maximum 200.
`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.

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 'brand_set=["Colorescience","CeraVe"]' \
  --data-urlencode aggregation_level=domain \
  --data-urlencode top_per_brand=10 \
  "${IQRUSH_API_BASE%/}/projects/${IQRUSH_PROJECT_ID}/runs/${IQRUSH_RUN_ID}/compare-grounding-sources"

Read the response

Returned data separates shared, brand-specific, and competitor-specific sources and includes gap signals when available. Shared and brand-specific labels describe the selected top sources for each brand. A shared-source estimate is copied from one contributing brand’s row, not combined across brands; do not present it as an all-brand rate. Inspect per-brand source reads when that distinction matters.

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.brand_set`	Brands included in the comparison.
`data.aggregation_level`	Source reporting unit requested for the comparison.
`data.shared_sources[].domain_or_url`	Source appearing in the selected leading sources for at least two requested brands.
`data.shared_sources[].brands`	Brands sharing that source within the selected lists.
`data.shared_sources[].estimate`	One contributing brand’s source estimate. It is not a combined estimate across the listed brands.

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": {
    "brand_set": [
      "Colorescience",
      "CeraVe"
    ],
    "aggregation_level": "domain",
    "shared_sources": [
      {
        "domain_or_url": "livetinted.com",
        "brands": [
          "CeraVe",
          "Colorescience"
        ],
        "estimate": {
          "value": 15.7,
          "ci": {
            "lower": 8.2,
            "upper": 28,
            "level": 0.95
          },
          "n": 8,
          "stability": "danger_zone",
          "stability_n": 8
        }
      }
    ]
  }
}

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

Compare source overlap — 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