> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentlinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read the competitor referring-site matrix

> Referring sites across your website and each saved competitor lookup, with filters (not linking to you, follow, spam, new/absent-to-dataset, competitor) and server pages.

`get_competitor_matrix`

Referring sites across your website and each saved competitor lookup, with filters (not linking to you, follow, spam, new/absent-to-dataset, competitor) and server pages. Reads saved rows only; no lookup, check or credit.

> [!NOTE]
>
> Hosted availability unverified: this name is absent from the 2026-10-27 deployment evidence. Check your connected catalog before calling. Provider configuration and workspace access still apply.

| Access | Behavior |
| - | - |
| `discovery:read`, `watches:read` | Reads saved data |

This read does not start a verification job.

## Example request

Connect through [MCP](https://docs.agentlinkops.com/guides/connect-mcp.md), [CLI](https://docs.agentlinkops.com/guides/connect-cli.md), or [HTTP](https://docs.agentlinkops.com/guides/connect-http.md). Replace example identifiers with records from your workspace.

```json MCP theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_competitor_matrix",
    "arguments": {
      "projectId": "prj_example",
      "notLinkingToYou": true,
      "spamMax": 30,
      "minCompetitors": 2,
      "limit": 100
    }
  }
}
```

```bash CLI theme={null}
agentlinkops call get_competitor_matrix --args '{"projectId":"prj_example","notLinkingToYou":true,"spamMax":30,"minCompetitors":2,"limit":100}'
```

```bash HTTP theme={null}
curl --fail-with-body https://app.agentlinkops.com/v1/commands/get_competitor_matrix \
  -H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"projectId":"prj_example","notLinkingToYou":true,"spamMax":30,"minCompetitors":2,"limit":100}'
```

## Returned result

Schema-validated example; IDs and dates are illustrative. MCP returns this data in `structuredContent` and in a text content block; generic HTTP and CLI return the JSON result directly.

> [accordion] Full response example
>
> ```json theme={null}
> {
>   "project_id": "prj_example",
>   "domain": "example.com",
>   "set": {
>     "id": "cs_example",
>     "revision": 2
>   },
>   "members": [
>     {
>       "member_id": "cm_example",
>       "domain": "rival.example",
>       "dataset": {
>         "dataset_id": "bl_example_rival",
>         "kind": "lookup",
>         "run_id": "dr_example_rival",
>         "provider": "dataforseo",
>         "data_mode": "provider_index",
>         "retrieved_at": "2026-10-19T08:00:00.000Z",
>         "retrieved": 1000,
>         "provider_total_count": 2629,
>         "row_limit": 1000,
>         "coverage": "capped",
>         "coverage_reason": null,
>         "rows_read": 1000,
>         "rows_truncated": false
>       },
>       "previous_dataset": null,
>       "dataset_difference": null
>     }
>   ],
>   "you": {
>     "domain": "example.com",
>     "monitored_sites": 42,
>     "index_lookup": null
>   },
>   "filters": {
>     "notLinkingToYou": true,
>     "follow": null,
>     "spamMax": 30,
>     "includeUnscored": false,
>     "dataset": null,
>     "memberId": null,
>     "minCompetitors": null,
>     "sort": "competitors"
>   },
>   "total_sites": 412,
>   "matching_sites": 1,
>   "you_status_counts": {
>     "monitored": 18,
>     "found_in_your_lookup": 0,
>     "not_found": 1
>   },
>   "items": [
>     {
>       "site": "resources.example.org",
>       "competitors_linking": 1,
>       "links": 2,
>       "follow": "follow",
>       "domain_rank": 512,
>       "spam_score": 4,
>       "you": {
>         "monitored_links": 0,
>         "index_links": 0,
>         "status": "not_found"
>       },
>       "dataset_change": null,
>       "example": {
>         "source_url": "https://resources.example.org/probate-tools",
>         "target_url": "https://rival.example/guide",
>         "anchor": "Probate guide",
>         "dofollow": true,
>         "lost": false
>       },
>       "members": [
>         {
>           "member_id": "cm_example",
>           "links": 2,
>           "follow": 2,
>           "nofollow": 0,
>           "lost_in_index": 0,
>           "domain_rank": 512,
>           "spam_score": 4,
>           "example": {
>             "source_url": "https://resources.example.org/probate-tools",
>             "target_url": "https://rival.example/guide",
>             "anchor": "Probate guide",
>             "dofollow": true,
>             "lost": false
>           },
>           "dataset_change": null
>         }
>       ]
>     }
>   ],
>   "has_more": false,
>   "next_cursor": null,
>   "scores": {
>     "domain_rank_scale": "0-1000",
>     "spam_score_scale": "0-100",
>     "source": "third_party_backlink_index",
>     "missing": "null, never 0"
>   },
>   "limits": {
>     "absence_claim": "not_supported",
>     "not_found_linking_to_you": "Not in your monitored links or your own saved lookup sample. This is not proof that the site does not link to you."
>   },
>   "spend": {
>     "supplier_requests": 0,
>     "credits": 0,
>     "checks": 0
>   }
> }
> ```

## Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

| Field | Type | Presence | Meaning and constraints |
| - | - | - | - |
| `projectId` | string | Required | project ID from create/list. minLength: `1`; maxLength: `128`; pattern: `"^[A-Za-z0-9_-]+$"` |
| `notLinkingToYou` | boolean | Optional | |
| `follow` | string | Optional | values: `"follow"`, `"nofollow"` |
| `spamMax` | integer / null | Optional | default: `30` |
| `includeUnscored` | boolean | Optional | default: `false` |
| `dataset` | string | Optional | values: `"new_to_dataset"`, `"absent_from_dataset"` |
| `memberId` | string | Optional | member ID from create/list. minLength: `1`; maxLength: `128`; pattern: `"^[A-Za-z0-9_-]+$"` |
| `minCompetitors` | integer | Optional | minimum: `1`; maximum: `10` |
| `sort` | string | Optional | default: `"competitors"`; values: `"competitors"`, `"domain_rank"`, `"links"`, `"site"` |
| `limit` | integer | Optional | Page/report row cap; see bounds. minimum: `1`; maximum: `500`; default: `100` |
| `cursor` | string | Optional | Opaque list cursor; omit initially. minLength: `1`; maxLength: `512` |

### Validation and omitted values

Each item is one referring site across your website and every current competitor's newest saved dataset. you.status is monitored (an explicitly monitored link), found\_in\_your\_lookup (your own saved lookup only) or not\_found; not\_found is never an absence claim.

Filters run on the server: notLinkingToYou, follow, spamMax (default 30; null for any; sites without a score are left out unless includeUnscored), dataset, memberId and minCompetitors. matching\_sites counts every match; you\_status\_counts ignores only the links-to-you filter.

Omit cursor for the first page and keep next\_cursor opaque with the same filters. A cursor read before the saved datasets, your monitored sites or the filters changed returns COMPETITOR\_MATRIX\_CHANGED; start again without it. Reading makes no supplier request, check, credit reservation or monitoring change.

Rows name sites, not saved candidates. To check one exact page before outreach, read the competitor's rows by members\[].dataset.dataset\_id: list\_domain\_baseline\_candidates for a lookup (bl\_), list\_competitor\_inventory\_rows for a captured inventory (ci\_). Then verify that candidate.

### Defaults when omitted

| Field | Default |
| - | - |
| `spamMax` | `30` |
| `includeUnscored` | `false` |
| `sort` | `"competitors"` |
| `limit` | `100` |

## Output fields

Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](https://docs.agentlinkops.com/reference/schemas.md) explain evidence states, empty lists and extensions.

* **`project_id`** (string, required): Project that owns this record.
* **`domain`** (string, required).
* **`set`** (object / null, required).
* **`members`** (array, required).
* **`you`** (object, required).
* **`filters`** (object, required).
* **`total_sites`** (number, required).
* **`matching_sites`** (number, required).
* **`you_status_counts`** (object, required).
* **`items`** (array, required): Records in this bounded page.
* **`has_more`** (boolean, required): True when another page is available.
* **`next_cursor`** (string / null, required): Opaque continuation for the same listing; null means no further page.
* **`scores`** (object, required).
* **`limits`** (object, required).
* **`spend`** (object, required).

> [accordion] All fields and nested objects
>
> Types, allowed values, limits and nested fields:
>
> | Field | Type | Presence | Meaning and constraints |
> | - | - | - | - |
> | `project_id` | string | Required | Project that owns this record. |
> | `domain` | string | Required | |
> | `set` | object / null | Required | |
> | `set.id` | string | Required | Resource identifier returned by the operation. |
> | `set.revision` | number | Required | Recorded revision. For an update, use the revision argument named by that operation. |
> | `members` | array | Required | |
> | `members[].member_id` | string | Required | Identifier returned by the related operation. |
> | `members[].domain` | string | Required | |
> | `members[].dataset` | object / null | Required | |
> | `members[].dataset.dataset_id` | string | Required | Identifier returned by the related operation. |
> | `members[].dataset.kind` | string | Required | values: `"lookup"`, `"inventory"` |
> | `members[].dataset.run_id` | string / null | Required | Identifier returned by the related operation. |
> | `members[].dataset.provider` | string / null | Required | |
> | `members[].dataset.data_mode` | string / null | Required | |
> | `members[].dataset.retrieved_at` | string / null | Required | |
> | `members[].dataset.retrieved` | number / null | Required | |
> | `members[].dataset.provider_total_count` | number / null | Required | |
> | `members[].dataset.row_limit` | number / null | Required | |
> | `members[].dataset.coverage` | string | Required | Dataset scope and completeness, including limits on what these results establish. values: `"complete"`, `"capped"`, `"partial"`, `"unknown"` |
> | `members[].dataset.coverage_reason` | string / null | Required | |
> | `members[].dataset.rows_read` | number / null | Required | |
> | `members[].dataset.rows_truncated` | boolean | Required | |
> | `members[].previous_dataset` | object / null | Required | |
> | `members[].previous_dataset.dataset_id` | string | Required | Identifier returned by the related operation. |
> | `members[].previous_dataset.kind` | string | Required | values: `"lookup"`, `"inventory"` |
> | `members[].previous_dataset.run_id` | string / null | Required | Identifier returned by the related operation. |
> | `members[].previous_dataset.provider` | string / null | Required | |
> | `members[].previous_dataset.data_mode` | string / null | Required | |
> | `members[].previous_dataset.retrieved_at` | string / null | Required | |
> | `members[].previous_dataset.retrieved` | number / null | Required | |
> | `members[].previous_dataset.provider_total_count` | number / null | Required | |
> | `members[].previous_dataset.row_limit` | number / null | Required | |
> | `members[].previous_dataset.coverage` | string | Required | Dataset scope and completeness, including limits on what these results establish. values: `"complete"`, `"capped"`, `"partial"`, `"unknown"` |
> | `members[].previous_dataset.coverage_reason` | string / null | Required | |
> | `members[].previous_dataset.rows_read` | number / null | Required | |
> | `members[].previous_dataset.rows_truncated` | boolean | Required | |
> | `members[].dataset_difference` | object / null | Required | |
> | `members[].dataset_difference.comparable` | boolean | Required | |
> | `members[].dataset_difference.reasons` | array | Required | |
> | `members[].dataset_difference.absence_claim` | string | Required | not\_supported: missing dataset rows cannot prove link absence. |
> | `you` | object | Required | |
> | `you.domain` | string | Required | |
> | `you.monitored_sites` | number | Required | |
> | `you.index_lookup` | object / null | Required | |
> | `you.index_lookup.dataset_id` | string | Required | Identifier returned by the related operation. |
> | `you.index_lookup.kind` | string | Required | values: `"lookup"`, `"inventory"` |
> | `you.index_lookup.run_id` | string / null | Required | Identifier returned by the related operation. |
> | `you.index_lookup.provider` | string / null | Required | |
> | `you.index_lookup.data_mode` | string / null | Required | |
> | `you.index_lookup.retrieved_at` | string / null | Required | |
> | `you.index_lookup.retrieved` | number / null | Required | |
> | `you.index_lookup.provider_total_count` | number / null | Required | |
> | `you.index_lookup.row_limit` | number / null | Required | |
> | `you.index_lookup.coverage` | string | Required | Dataset scope and completeness, including limits on what these results establish. values: `"complete"`, `"capped"`, `"partial"`, `"unknown"` |
> | `you.index_lookup.coverage_reason` | string / null | Required | |
> | `you.index_lookup.rows_read` | number / null | Required | |
> | `you.index_lookup.rows_truncated` | boolean | Required | |
> | `filters` | object | Required | |
> | `filters.notLinkingToYou` | boolean | Required | |
> | `filters.follow` | string / null | Required | |
> | `filters.spamMax` | number / null | Required | |
> | `filters.includeUnscored` | boolean | Required | |
> | `filters.dataset` | string / null | Required | |
> | `filters.memberId` | string / null | Required | Identifier returned by the related operation. |
> | `filters.minCompetitors` | number / null | Required | |
> | `filters.sort` | string | Required | |
> | `total_sites` | number | Required | |
> | `matching_sites` | number | Required | |
> | `you_status_counts` | object | Required | |
> | `you_status_counts.monitored` | number | Required | |
> | `you_status_counts.found_in_your_lookup` | number | Required | |
> | `you_status_counts.not_found` | number | Required | |
> | `items` | array | Required | Records in this bounded page. |
> | `items[].site` | string | Required | |
> | `items[].competitors_linking` | number | Required | |
> | `items[].links` | number | Required | |
> | `items[].follow` | string | Required | values: `"follow"`, `"nofollow"`, `"unknown"` |
> | `items[].domain_rank` | number / null | Required | |
> | `items[].spam_score` | number / null | Required | |
> | `items[].you` | object | Required | |
> | `items[].you.monitored_links` | number | Required | |
> | `items[].you.index_links` | number | Required | |
> | `items[].you.status` | string | Required | Resource lifecycle status. values: `"monitored"`, `"found_in_your_lookup"`, `"not_found"` |
> | `items[].dataset_change` | string / null | Required | |
> | `items[].example` | object / null | Required | |
> | `items[].example.source_url` | string | Required | Publisher page URL recorded in this evidence. |
> | `items[].example.target_url` | string / null | Required | Destination URL recorded in this evidence. |
> | `items[].example.anchor` | string / null | Required | |
> | `items[].example.dofollow` | boolean / null | Required | |
> | `items[].example.lost` | boolean | Required | |
> | `items[].members` | array | Required | |
> | `items[].members[].member_id` | string | Required | Identifier returned by the related operation. |
> | `items[].members[].links` | number | Required | |
> | `items[].members[].follow` | number | Required | |
> | `items[].members[].nofollow` | number | Required | |
> | `items[].members[].lost_in_index` | number | Required | |
> | `items[].members[].domain_rank` | number / null | Required | |
> | `items[].members[].spam_score` | number / null | Required | |
> | `items[].members[].example` | object / null | Required | |
> | `items[].members[].example.source_url` | string | Required | Publisher page URL recorded in this evidence. |
> | `items[].members[].example.target_url` | string / null | Required | Destination URL recorded in this evidence. |
> | `items[].members[].example.anchor` | string / null | Required | |
> | `items[].members[].example.dofollow` | boolean / null | Required | |
> | `items[].members[].example.lost` | boolean | Required | |
> | `items[].members[].dataset_change` | string / null | Required | |
> | `has_more` | boolean | Required | True when another page is available. |
> | `next_cursor` | string / null | Required | Opaque continuation for the same listing; null means no further page. |
> | `scores` | object | Required | |
> | `scores.domain_rank_scale` | string | Required | |
> | `scores.spam_score_scale` | string | Required | |
> | `scores.source` | string | Required | |
> | `scores.missing` | string | Required | |
> | `limits` | object | Required | |
> | `limits.absence_claim` | string | Required | not\_supported: missing dataset rows cannot prove link absence. must equal `"not_supported"` |
> | `limits.not_found_linking_to_you` | string | Required | |
> | `spend` | object | Required | |
> | `spend.supplier_requests` | number | Required | must equal `0` |
> | `spend.credits` | number | Required | must equal `0` |
> | `spend.checks` | number | Required | must equal `0` |

[Download input schema](https://docs.agentlinkops.com/schemas/get_competitor_matrix.input.json) · [Download output schema](https://docs.agentlinkops.com/schemas/get_competitor_matrix.output.json)

## Errors and retries

Follow the error recovery before retrying this read. Preserve the selected workspace, project, filters and feed. Recovering a read does not require an idempotency key or another verification job. Operation-specific errors include `INVALID_COMPETITOR_COMPARISON_INPUT`, `INVALID_CURSOR`, `COMPETITOR_MATRIX_CHANGED`, `COMPETITOR_MEMBER_NOT_FOUND`, `PROJECT_NOT_FOUND`.

See [error recovery](https://docs.agentlinkops.com/reference/errors.md) for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

## HTTP resource routes

This operation has no separate resource alias. Use its generic command route in a matching environment.

## Continue

[get\_competitor\_comparison](https://docs.agentlinkops.com/reference/commands/get_competitor_comparison.md) · [list\_domain\_baseline\_candidates](https://docs.agentlinkops.com/reference/commands/list_domain_baseline_candidates.md) · [list\_competitor\_inventory\_rows](https://docs.agentlinkops.com/reference/commands/list_competitor_inventory_rows.md)

Follow the [related workflow](https://docs.agentlinkops.com/guides/competitor-research.md). See [capability status](https://docs.agentlinkops.com/capability-status.md) for availability or the [command index](https://docs.agentlinkops.com/reference/index.md) for another operation.


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