> ## 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 citation scores — HTTP

> Read citation share or citation coverage for domains or pages.

Read citation share or citation coverage for domains or pages.

**Method:** `GET`

**Path:** `/projects/{project_id}/runs/{run_id}/citation-score`

Use the HTTP base for your authorized environment and an `Authorization: Bearer` header. See [authentication](/developers/guides/04-authentication) and [HTTP setup](/developers/guides/06-http-quickstart).

## 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 | `"share"` | share requests a source’s share of citations; coverage requests how often responses cite it. Both are proportions. Set this explicitly when comparing interfaces. |
| `aggregation_level` | query | string | No | `"domain"` | domain requests source-domain results; url requests individual-page results. Keep the same reporting unit when comparing measurements. |
| `group_by` | query | string | No | `null` | JSON-encoded array. For domain results, request platform, topic, intent, or prompt\_type groups. URL results do not apply group\_by in this edition. Check the returned warnings and row labels. |
| `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 sources with kind: leaderboard, all, owned, or specified. For specified, provide domains containing exact source keys for the requested reporting unit. |

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

```bash theme={null}
curl --fail-with-body --silent --show-error --get \
  --header "Authorization: Bearer ${IQRUSH_ACCESS_TOKEN}" \
  --header "Accept: application/json" \
  --data-urlencode metric=coverage \
  --data-urlencode aggregation_level=domain \
  --data-urlencode 'group_by=["platform"]' \
  --data-urlencode 'subject={"kind":"owned"}' \
  "${IQRUSH_API_BASE%/}/projects/${IQRUSH_PROJECT_ID}/runs/${IQRUSH_RUN_ID}/citation-score"
```

## Read the response

Measurement envelope with `data.metric`, `data.aggregation_level`, and `data.rows`. Rows include `domain_or_url`, `group_by_values`, `estimate`, source flags, and segment labels when available.

Share and coverage have different denominators. Values and interval bounds use proportions. Use owned/all/specified citation subjects and inspect selection counts.

### 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` | share or coverage, identifying which citation measure was returned. |
| `data.aggregation_level` | domain or url, identifying the source reporting unit. |
| `data.rows[].domain_or_url` | The source measured by this row. |
| `data.rows[].group_by_values` | Dimension labels for this row; preserve them beside its estimate. |
| `data.rows[].estimate` | Value, confidence interval, and row quality. Citation score values and bounds are proportions. |
| `data.filters_applied.warnings` | Scope limitations to review before interpreting a filtered or grouped result. |

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

```json theme={null}
{
  "data_ready": true,
  "data": {
    "metric": "coverage",
    "aggregation_level": "domain",
    "rows": [
      {
        "domain_or_url": "colorescience.com",
        "group_by_values": {
          "platform": "VERTEX"
        },
        "estimate": {
          "value": 0.275,
          "ci": {
            "lower": 0.222389,
            "upper": 0.334701,
            "level": 0.95
          },
          "n": 240,
          "stability": "stable",
          "stability_n": 240
        }
      }
    ],
    "filters_applied": {
      "filters": {},
      "group_by": [
        "platform"
      ],
      "warnings": []
    }
  }
}
```

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

MCP equivalent: [`get_citation_score`](/developers/tools/get_citation_score). 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](/developers/guides/13-errors) shows observed examples.


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