Skip to main content
get_competitor_gap_report Compare selected frozen inventories by exact page or source host. Requires saved inventory IDs from list_competitor_inventories; new admission can be disabled. Missing edges are dataset-qualified; incomplete data cannot establish gaps. Page groups or pass groupKey for exact contributor rows. Select exclusionRevision explicitly to apply saved rules. Never buys discovery or checks links.
Available in the deployed MCP and HTTP bundle. Confirm access and inputs with your connected catalog. Workspace scopes and enabled providers 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

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. 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

Omit cursor for the first page. Keep continuation cursors opaque and use them only with the same listing and filters. grouping is required: there is no implicit page/host grouping. Select exclusionRevision explicitly to apply saved rules; omitted exclusionRevision uses only request exclusions. Selected inventories must be distinct, compatible with the approved revision and include the required customer inventory. Missing dataset edges cannot establish web-wide absence. Omitting groupKey returns groups. Supplying a returned groupKey pages its exact contributor rows. The cursor binds the report and selected group.

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.
  • v (number, required).
  • report_hash (string, required).
  • set_id (string, required): Identifier returned by the related operation.
  • set_revision (number, required).
  • grouping (string, required).
  • comparison (object, required).
  • absence_claim (string, required): not_supported: missing dataset rows cannot prove link absence. must equal “not_supported”
  • whole_web_coverage (boolean, required): False: these results do not measure the whole web. must equal false
  • coverage_scope (string, required).
  • verification_view (string, required).
  • max_retrieval_skew_ms (number, required).
  • selected_inventory_ids (array, required).
  • unselected_member_ids (array, required).
  • exclusions (object, required).
  • inventories (array, required).
  • counts (object / null, required).
  • view (string, required): values: “groups”, “rows”
  • group (object, optional).
  • 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.
Download input schema · Download output schema

Errors and retries

The command is annotated idempotent. Reuse an accepted idempotency key when the input provides one; changing the payload under a reused key can conflict. See error recovery for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

HTTP resource routes

These existing resource routes share the operation’s domain behavior. Their parameter placement, status and response envelope can differ from generic invocation. See HTTP route details.

Continue

list_competitor_inventory_rows Follow the related workflow, inspect capability status, or return to the command index.