Skip to main content
get_competitor_gap_report Compare frozen inventories by exact page or source host using IDs from list_competitor_inventories; new admission may be disabled. Gaps require complete selected data. Page groups or use groupKey for contributors; exclusionRevision applies saved rules. No discovery or checks.
Name recorded in the 2026-10-17 deployment. This page describes current source; verify inputs and access in your connected catalog. 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.
  • setId (string, required): set ID from create/list. minLength: 1; maxLength: 200
  • revision (integer, required): Immutable set revision to read/compare. minimum: 1; maximum: 9007199254740990
  • inventoryIds (array, required): Frozen inventory IDs to compare within the approved set. minItems: 2; maxItems: 11
  • grouping (string, required): Aggregate selected inventories by this dimension. values: "page", "source_host"
  • exclusions (array, optional): Customer-approved exclusions to apply to this report. maxItems: 100; default: []
  • maxRetrievalSkewMs (integer, optional): Maximum inventory retrieval-time skew in milliseconds. minimum: 0; maximum: 86400000; default: 86400000
  • exclusionRevision (integer, optional): Saved exclusion revision; historical revisions stay immutable. minimum: 1; maximum: 9007199254740990
  • groupKey (string, optional): Exact group key returned by the report being inspected. minLength: 1; maxLength: 4096
  • cursor (string, optional): Opaque list cursor; omit initially. minLength: 1; maxLength: 16384
  • limit (integer, optional): Page/report row cap; see bounds. minimum: 1; maximum: 100; default: 50
  • browse (boolean, optional): Server-sorted authorized saved rows; omit for legacy paging.
  • sort (string, optional): Allowlisted saved-field identifier. minLength: 1; maxLength: 80
  • order (string, optional): Sort direction; stable ID ties, nulls last. values: "asc", "desc"
  • q (string, optional): Literal search of supported saved fields. maxLength: 500
  • table_filters (string / array, optional): Up to 12 allowlisted column filters before paging.
Types, allowed values, limits and nested fields:

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.
  • total (integer / null, optional).
  • 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.
  • page (object, optional).
  • 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.
  • whole_web_coverage (boolean, required): False: these results do not measure the whole web.
  • 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).
  • group (object, optional).
  • items (array, required): Records in this bounded page.
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. 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. See capability status for availability or the command index for another operation.