Skip to main content
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.
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.
This read does not start a verification job.

Example request

Connect through MCP, CLI, or HTTP. Replace example identifiers with records from your workspace.

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.

Input fields

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

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

Output fields

Fields inside optional or nullable parents apply only when that parent exists. Common schema conventions 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).
Types, allowed values, limits and nested fields:
Download input schema · Download output schema

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 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 · list_domain_baseline_candidates · list_competitor_inventory_rows Follow the related workflow. See capability status for availability or the command index for another operation.