Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Read citation share or citation coverage for domains or pages.
get_citation_score. Operation: read. Uses the authorized connection; no project or content changes are made by this tool.
| 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 | '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 | string | No | 'domain' | domain requests source-domain results; url requests individual-page results. Keep the same reporting unit when comparing measurements. |
group_by | string[] or null | No | null | 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 | 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 sources with kind: leaderboard, all, owned, or specified. For specified, provide domains containing exact source keys for the requested reporting unit. |
params object for MCP tools/call.
{
"name": "get_citation_score",
"arguments": {
"project_id": "PROJECT_ID",
"run_id": "RUN_ID",
"metric": "coverage",
"aggregation_level": "domain",
"subject": {
"kind": "owned"
},
"group_by": [
"platform"
]
}
}
data.metric, data.aggregation_level, and data.rows. Rows include domain_or_url, group_by_values, estimate, source flags, and segment labels when available.
| 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. |
{
"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": []
}
}
}