> ## 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.

# Get competitor gap report

> Compare selected frozen inventories by exact page or source host.

`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.

<Note>Available in the deployed MCP and HTTP bundle. Confirm access and inputs with your connected catalog. Workspace scopes and enabled providers still apply.</Note>

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

This read does not start a verification job.

## Example request

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

<CodeGroup>
  ```json MCP theme={null}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "get_competitor_gap_report",
      "arguments": {
        "setId": "set_example",
        "revision": 1,
        "inventoryIds": [
          "inventory_example",
          "inventory_example_1"
        ],
        "grouping": "page"
      }
    }
  }
  ```

  ```bash CLI theme={null}
  agentlinkops call get_competitor_gap_report --args '{"setId":"set_example","revision":1,"inventoryIds":["inventory_example","inventory_example_1"],"grouping":"page"}'
  ```

  ```bash HTTP theme={null}
  curl "$AGENTLINKOPS_API_URL/v1/commands/get_competitor_gap_report" \
    -H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
    -H 'Content-Type: application/json' \
    --data '{"setId":"set_example","revision":1,"inventoryIds":["inventory_example","inventory_example_1"],"grouping":"page"}'
  ```
</CodeGroup>

## 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.

<Accordion title="Full response example">
  ```json theme={null}
  {
    "v": 1,
    "report_hash": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
    "set_id": "set_example",
    "set_revision": 1,
    "grouping": "page",
    "comparison": {
      "mode": "observed_overlap_only",
      "reasons": [
        "incomplete_query_coverage"
      ],
      "absence_claim": "not_supported"
    },
    "absence_claim": "not_supported",
    "whole_web_coverage": false,
    "coverage_scope": "selected_inventory_datasets",
    "verification_view": "captured_at_snapshot",
    "max_retrieval_skew_ms": 86400000,
    "selected_inventory_ids": [
      "inventory_example",
      "inventory_example_1"
    ],
    "unselected_member_ids": [],
    "exclusions": {
      "scope": "request_only",
      "policy": "any_source_row_hides_group",
      "rules": []
    },
    "inventories": [
      {
        "v": 1,
        "id": "inventory_example",
        "workspace_id": "ws_example",
        "project_id": "pr_example",
        "set_id": "set_example",
        "set_revision": 1,
        "set_hash": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
        "member_id": "cm_customer",
        "member_role": "customer",
        "target_scope_id": "ts_example",
        "captured_at": "2026-09-13T12:00:00.000Z",
        "provider_retrieved_from": "2026-09-13T12:00:00.000Z",
        "provider_retrieved_to": "2026-09-13T12:00:00.000Z",
        "run": {
          "v": 1,
          "id": "dr_example",
          "workspace_id": "ws_example",
          "project_id": "pr_example",
          "provider": "linktrail_corpus",
          "data_mode": "owned_corpus",
          "query": {
            "target_kind": "domain",
            "target": "example.com",
            "include_subdomains": true,
            "backlinks_status_type": "live",
            "exclude_internal_backlinks": true,
            "mode": "as_is",
            "filters": null,
            "order_by": [
              "first_seen,desc"
            ],
            "rank_scale": null,
            "page_limit": 100,
            "row_limit": 100
          },
          "status": "succeeded",
          "created_at": "2026-09-13T12:00:00.000Z",
          "started_at": "2026-09-13T12:00:00.000Z",
          "finished_at": "2026-09-13T12:00:00.000Z",
          "coverage": "complete_for_query",
          "coverage_reason": null,
          "provider_total_count": 1,
          "usage": {
            "unit": "discovery",
            "currency": "USD",
            "quote_id": "owned_example",
            "max_cost_microusd": 0,
            "reserved_cost_microusd": 0,
            "provider_reported_cost_microusd": 0,
            "request_count": 1,
            "returned_rows": 1,
            "accepted_candidates": 1,
            "rejected_rows": 0,
            "duplicate_rows": 0
          },
          "operation": "backlinks",
          "coverage_scope": "corpus_subset",
          "whole_web_coverage": false
        },
        "content_hash": "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd",
        "absence_claim": "not_supported",
        "verification_view": "captured_at_snapshot"
      },
      {
        "v": 1,
        "id": "inventory_example_1",
        "workspace_id": "ws_example",
        "project_id": "pr_example",
        "set_id": "set_example",
        "set_revision": 1,
        "set_hash": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
        "member_id": "cm_competitor",
        "member_role": "competitor",
        "target_scope_id": "ts_example",
        "captured_at": "2026-09-13T12:00:00.000Z",
        "provider_retrieved_from": "2026-09-13T12:00:00.000Z",
        "provider_retrieved_to": "2026-09-13T12:00:00.000Z",
        "run": {
          "v": 1,
          "id": "dr_example",
          "workspace_id": "ws_example",
          "project_id": "pr_example",
          "provider": "linktrail_corpus",
          "data_mode": "owned_corpus",
          "query": {
            "target_kind": "domain",
            "target": "competitor.example.org",
            "include_subdomains": true,
            "backlinks_status_type": "live",
            "exclude_internal_backlinks": true,
            "mode": "as_is",
            "filters": null,
            "order_by": [
              "first_seen,desc"
            ],
            "rank_scale": null,
            "page_limit": 100,
            "row_limit": 100
          },
          "status": "succeeded",
          "created_at": "2026-09-13T12:00:00.000Z",
          "started_at": "2026-09-13T12:00:00.000Z",
          "finished_at": "2026-09-13T12:00:00.000Z",
          "coverage": "partial",
          "coverage_reason": "row_limit",
          "provider_total_count": 1,
          "usage": {
            "unit": "discovery",
            "currency": "USD",
            "quote_id": "owned_example",
            "max_cost_microusd": 0,
            "reserved_cost_microusd": 0,
            "provider_reported_cost_microusd": 0,
            "request_count": 1,
            "returned_rows": 1,
            "accepted_candidates": 1,
            "rejected_rows": 0,
            "duplicate_rows": 0
          },
          "operation": "backlinks",
          "coverage_scope": "corpus_subset",
          "whole_web_coverage": false
        },
        "content_hash": "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd",
        "absence_claim": "not_supported",
        "verification_view": "captured_at_snapshot"
      }
    ],
    "counts": {
      "groups": 1,
      "rows": 2,
      "observed_overlap_groups": 1,
      "dataset_gap_groups": null,
      "comparison_unknown_groups": 0,
      "excluded_groups": 0,
      "excluded_rows": 0
    },
    "view": "groups",
    "items": [
      {
        "key": "https://publisher.example.org/article",
        "relation": "observed_overlap",
        "competitor_count": 1,
        "row_count": 2,
        "customer_row_count": 1,
        "competitor_row_count": 1,
        "contributors": [
          {
            "member_id": "cm_customer",
            "member_role": "customer",
            "inventory_id": "inventory_example",
            "row_count": 1
          },
          {
            "member_id": "cm_competitor",
            "member_role": "competitor",
            "inventory_id": "inventory_example_1",
            "row_count": 1
          }
        ]
      }
    ],
    "has_more": false,
    "next_cursor": null
  }
  ```
</Accordion>

## 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                                                                                                           |
| ----------------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `setId`                 | string  | Required | Identifier of the set returned by its create or list operation. minLength: 1; maxLength: 200                                      |
| `revision`              | integer | Required | Immutable set revision to read or compare. minimum: 1; maximum: 9007199254740990                                                  |
| `inventoryIds`          | array   | Required | Frozen inventory IDs to compare; records must belong to the approved set. minItems: 2; maxItems: 11                               |
| `grouping`              | string  | Required | Grouping dimension used to aggregate the selected inventories. values: "page", "source\_host"                                     |
| `exclusions`            | array   | Optional | Customer-approved exclusions to apply to this report. maxItems: 100; default: \[]                                                 |
| `exclusions[].grouping` | string  | Required | values: "page", "source\_host"                                                                                                    |
| `exclusions[].value`    | string  | Required | minLength: 1; maxLength: 4096                                                                                                     |
| `maxRetrievalSkewMs`    | integer | Optional | Maximum permitted difference between inventory retrieval times, in milliseconds. minimum: 0; maximum: 86400000; default: 86400000 |
| `exclusionRevision`     | integer | Optional | Saved exclusion revision to apply; historical revisions remain 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 continuation returned by this same listing; omit for the first page. minLength: 1; maxLength: 1024                         |
| `limit`                 | integer | Optional | Maximum rows in this page or bounded report; subject to the schema maximum. minimum: 1; maximum: 100; default: 50                 |

### 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

| Field                | Default    |
| -------------------- | ---------- |
| `limit`              | `50`       |
| `exclusions`         | `[]`       |
| `maxRetrievalSkewMs` | `86400000` |

## Output fields

Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](/reference/schemas) 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.

<Accordion title="All fields and nested objects">
  | Field                                                                     | Type                     | Presence | Meaning and constraints                                                                                                                                                                                                                                                                                                                                                                      |
  | ------------------------------------------------------------------------- | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `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 |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `comparison.mode`                                                         | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `comparison.reasons`                                                      | array                    | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `comparison.absence_claim`                                                | string                   | Required | not\_supported: missing dataset rows cannot prove link absence. must equal "not\_supported"                                                                                                                                                                                                                                                                                                  |
  | `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 |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `exclusions.scope`                                                        | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `exclusions.policy`                                                       | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `exclusions.rules`                                                        | array                    | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `exclusions.rules[].grouping`                                             | string                   | Required | values: "page", "source\_host"                                                                                                                                                                                                                                                                                                                                                               |
  | `exclusions.rules[].value`                                                | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `exclusions.saved_revision`                                               | number                   | Optional |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `exclusions.set_revision_at_save`                                         | number                   | Optional |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories`                                                             | array                    | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].v`                                                         | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].id`                                                        | string                   | Required | Resource identifier returned by the operation.                                                                                                                                                                                                                                                                                                                                               |
  | `inventories[].workspace_id`                                              | string                   | Required | Workspace that owns this record.                                                                                                                                                                                                                                                                                                                                                             |
  | `inventories[].project_id`                                                | string                   | Required | Project that owns this record.                                                                                                                                                                                                                                                                                                                                                               |
  | `inventories[].set_id`                                                    | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `inventories[].set_revision`                                              | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].set_hash`                                                  | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].member_id`                                                 | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `inventories[].member_role`                                               | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].target_scope_id`                                           | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `inventories[].captured_at`                                               | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].provider_retrieved_from`                                   | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].provider_retrieved_to`                                     | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run`                                                       | object                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.v`                                                     | number                   | Required | must equal 1                                                                                                                                                                                                                                                                                                                                                                                 |
  | `inventories[].run.id`                                                    | string                   | Required | Resource identifier returned by the operation. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$"                                                                                                                                                                                                                                                                                  |
  | `inventories[].run.workspace_id`                                          | string                   | Required | Workspace that owns this record. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$"                                                                                                                                                                                                                                                                                                |
  | `inventories[].run.project_id`                                            | string                   | Required | Project that owns this record. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$"                                                                                                                                                                                                                                                                                                  |
  | `inventories[].run.provider`                                              | string                   | Required | values: "linktrail\_corpus", "dataforseo", "imported"                                                                                                                                                                                                                                                                                                                                        |
  | `inventories[].run.data_mode`                                             | string                   | Required | values: "synthetic", "owned\_corpus", "provider\_index", "imported"                                                                                                                                                                                                                                                                                                                          |
  | `inventories[].run.query`                                                 | object                   | Required | additional fields rejected                                                                                                                                                                                                                                                                                                                                                                   |
  | `inventories[].run.query.target_kind`                                     | string                   | Required | values: "domain", "exact\_url"                                                                                                                                                                                                                                                                                                                                                               |
  | `inventories[].run.query.target`                                          | string                   | Required | minLength: 1; maxLength: 4096                                                                                                                                                                                                                                                                                                                                                                |
  | `inventories[].run.query.include_subdomains`                              | boolean                  | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.query.backlinks_status_type`                           | string                   | Required | values: "live", "lost", "all"                                                                                                                                                                                                                                                                                                                                                                |
  | `inventories[].run.query.exclude_internal_backlinks`                      | boolean                  | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.query.mode`                                            | string                   | Required | must equal "as\_is"                                                                                                                                                                                                                                                                                                                                                                          |
  | `inventories[].run.query.filters`                                         | null                     | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.query.order_by`                                        | array                    | Required | minItems: 1; maxItems: 1                                                                                                                                                                                                                                                                                                                                                                     |
  | `inventories[].run.query.rank_scale`                                      | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.query.page_limit`                                      | integer                  | Required | minimum: 1; maximum: 1000                                                                                                                                                                                                                                                                                                                                                                    |
  | `inventories[].run.query.row_limit`                                       | integer                  | Required | minimum: 1; maximum: 1000                                                                                                                                                                                                                                                                                                                                                                    |
  | `inventories[].run.status`                                                | string                   | Required | Resource lifecycle status. values: "queued", "running", "succeeded", "partial", "failed", "reconciliation\_required"                                                                                                                                                                                                                                                                         |
  | `inventories[].run.created_at`                                            | string                   | Required | UTC timestamp when the record was created. format: "date-time"; pattern: "^(?:(?:\d\d\[2468]\[048]\|\d\d\[13579]\[26]\|\d\d0\[48]\|\[02468]\[048]00\|\[13579]\[26]00)-02-29\|\d\{4}-(?:(?:0\[13578]\|1\[02])-(?:0\[1-9]\|\[12]\d\|3\[01])\|(?:0\[469]\|11)-(?:0\[1-9]\|\[12]\d\|30)\|(?:02)-(?:0\[1-9]\|1\d\|2\[0-8])))T(?:(?:\[01]\d\|2\[0-3]):\[0-5]\d:\[0-5]\d\\.\d\{3}(?:Z))\$"          |
  | `inventories[].run.started_at`                                            | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.finished_at`                                           | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.coverage`                                              | string                   | Required | Dataset scope and completeness, including limits on what these results establish. values: "pending", "complete\_for\_query", "capped", "partial", "unknown"                                                                                                                                                                                                                                  |
  | `inventories[].run.coverage_reason`                                       | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.provider_total_count`                                  | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.usage`                                                 | object                   | Required | additional fields rejected                                                                                                                                                                                                                                                                                                                                                                   |
  | `inventories[].run.usage.unit`                                            | string                   | Required | must equal "discovery"                                                                                                                                                                                                                                                                                                                                                                       |
  | `inventories[].run.usage.currency`                                        | string                   | Required | must equal "USD"                                                                                                                                                                                                                                                                                                                                                                             |
  | `inventories[].run.usage.quote_id`                                        | string                   | Required | Identifier returned by the related operation. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$"                                                                                                                                                                                                                                                                                   |
  | `inventories[].run.usage.max_cost_microusd`                               | integer                  | Required | minimum: 0; maximum: 9007199254740991                                                                                                                                                                                                                                                                                                                                                        |
  | `inventories[].run.usage.reserved_cost_microusd`                          | integer                  | Required | minimum: 0; maximum: 9007199254740991                                                                                                                                                                                                                                                                                                                                                        |
  | `inventories[].run.usage.provider_reported_cost_microusd`                 | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.usage.request_count`                                   | integer                  | Required | minimum: 0; maximum: 9007199254740991                                                                                                                                                                                                                                                                                                                                                        |
  | `inventories[].run.usage.returned_rows`                                   | integer                  | Required | minimum: 0; maximum: 9007199254740991                                                                                                                                                                                                                                                                                                                                                        |
  | `inventories[].run.usage.accepted_candidates`                             | integer                  | Required | minimum: 0; maximum: 9007199254740991                                                                                                                                                                                                                                                                                                                                                        |
  | `inventories[].run.usage.rejected_rows`                                   | integer                  | Required | minimum: 0; maximum: 9007199254740991                                                                                                                                                                                                                                                                                                                                                        |
  | `inventories[].run.usage.duplicate_rows`                                  | integer                  | Required | minimum: 0; maximum: 9007199254740991                                                                                                                                                                                                                                                                                                                                                        |
  | `inventories[].run.operation`                                             | string                   | Required | must equal "backlinks"                                                                                                                                                                                                                                                                                                                                                                       |
  | `inventories[].run.coverage_scope`                                        | string                   | Required | values: "customer\_import", "corpus\_subset", "provider\_query"                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].run.whole_web_coverage`                                    | boolean                  | Required | False: these results do not measure the whole web. must equal false                                                                                                                                                                                                                                                                                                                          |
  | `inventories[].run.replayed`                                              | boolean                  | Optional | True when the response reuses an earlier request with the same idempotency value.                                                                                                                                                                                                                                                                                                            |
  | `inventories[].content_hash`                                              | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `inventories[].absence_claim`                                             | string                   | Required | not\_supported: missing dataset rows cannot prove link absence. must equal "not\_supported"                                                                                                                                                                                                                                                                                                  |
  | `inventories[].verification_view`                                         | string                   | Required | must equal "captured\_at\_snapshot"                                                                                                                                                                                                                                                                                                                                                          |
  | `inventories[].replayed`                                                  | boolean                  | Optional | True when the response reuses an earlier request with the same idempotency value.                                                                                                                                                                                                                                                                                                            |
  | `counts`                                                                  | object / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `counts.groups`                                                           | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `counts.rows`                                                             | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `counts.observed_overlap_groups`                                          | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `counts.dataset_gap_groups`                                               | number / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `counts.comparison_unknown_groups`                                        | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `counts.excluded_groups`                                                  | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `counts.excluded_rows`                                                    | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `view`                                                                    | string                   | Required | values: "groups", "rows"                                                                                                                                                                                                                                                                                                                                                                     |
  | `group`                                                                   | object                   | Optional |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `group.key`                                                               | string                   | Required | Saved lookup identifier within this record.                                                                                                                                                                                                                                                                                                                                                  |
  | `group.relation`                                                          | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `group.competitor_count`                                                  | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `group.row_count`                                                         | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `group.customer_row_count`                                                | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `group.competitor_row_count`                                              | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `group.contributors`                                                      | array                    | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `group.contributors[].member_id`                                          | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `group.contributors[].member_role`                                        | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `group.contributors[].inventory_id`                                       | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `group.contributors[].row_count`                                          | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items`                                                                   | array                    | Required | Records in this bounded page.                                                                                                                                                                                                                                                                                                                                                                |
  | `items[].key`                                                             | string                   | Required | Saved lookup identifier within this record.                                                                                                                                                                                                                                                                                                                                                  |
  | `items[].relation`                                                        | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].competitor_count`                                                | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].row_count`                                                       | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].customer_row_count`                                              | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].competitor_row_count`                                            | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].contributors`                                                    | array                    | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].contributors[].member_id`                                        | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `items[].contributors[].member_role`                                      | string                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].contributors[].inventory_id`                                     | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `items[].contributors[].row_count`                                        | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].v`                                                               | number                   | Required | must equal 1                                                                                                                                                                                                                                                                                                                                                                                 |
  | `items[].id`                                                              | string                   | Required | Resource identifier returned by the operation. pattern: "^dc\_\[a-f0-9]\{64}\$"                                                                                                                                                                                                                                                                                                              |
  | `items[].workspace_id`                                                    | string                   | Required | Workspace that owns this record. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$"                                                                                                                                                                                                                                                                                                |
  | `items[].project_id`                                                      | string                   | Required | Project that owns this record. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$"                                                                                                                                                                                                                                                                                                  |
  | `items[].discovery_run_id`                                                | string                   | Required | Identifier returned by the related operation. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$"                                                                                                                                                                                                                                                                                   |
  | `items[].source_url`                                                      | string                   | Required | Publisher page URL recorded in this evidence. maxLength: 4096                                                                                                                                                                                                                                                                                                                                |
  | `items[].target_url`                                                      | string                   | Required | Destination URL recorded in this evidence. maxLength: 4096                                                                                                                                                                                                                                                                                                                                   |
  | `items[].provider`                                                        | string                   | Required | values: "linktrail\_corpus", "dataforseo", "imported"                                                                                                                                                                                                                                                                                                                                        |
  | `items[].data_mode`                                                       | string                   | Required | values: "synthetic", "owned\_corpus", "provider\_index", "imported"                                                                                                                                                                                                                                                                                                                          |
  | `items[].provider_retrieved_at`                                           | string                   | Required | Timestamp when the upstream evidence was retrieved. format: "date-time"; pattern: "^(?:(?:\d\d\[2468]\[048]\|\d\d\[13579]\[26]\|\d\d0\[48]\|\[02468]\[048]00\|\[13579]\[26]00)-02-29\|\d\{4}-(?:(?:0\[13578]\|1\[02])-(?:0\[1-9]\|\[12]\d\|3\[01])\|(?:0\[469]\|11)-(?:0\[1-9]\|\[12]\d\|30)\|(?:02)-(?:0\[1-9]\|1\d\|2\[0-8])))T(?:(?:\[01]\d\|2\[0-3]):\[0-5]\d:\[0-5]\d\\.\d\{3}(?:Z))\$" |
  | `items[].provider_first_seen`                                             | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_prev_seen`                                              | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_last_seen`                                              | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_status`                                                 | object                   | Required | additional fields rejected                                                                                                                                                                                                                                                                                                                                                                   |
  | `items[].provider_status.is_lost`                                         | boolean / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_status.is_broken`                                       | boolean / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_status.is_new`                                          | boolean / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].anchor`                                                          | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].rel`                                                             | array / null             | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].dofollow`                                                        | boolean / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].link_type`                                                       | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].source_http_status`                                              | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].target_http_status`                                              | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].links_count`                                                     | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics`                                                | object / object / object | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics.dataforseo`                                     | object                   | Required | additional fields rejected                                                                                                                                                                                                                                                                                                                                                                   |
  | `items[].provider_metrics.dataforseo.rank`                                | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics.dataforseo.page_from_rank`                      | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics.dataforseo.domain_from_rank`                    | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics.dataforseo.backlink_spam_score`                 | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics.dataforseo.rank_scale`                          | string                   | Required | must equal "one\_thousand"                                                                                                                                                                                                                                                                                                                                                                   |
  | `items[].provider_metrics.imported`                                       | object                   | Required | additional fields rejected                                                                                                                                                                                                                                                                                                                                                                   |
  | `items[].provider_metrics.imported.supplier`                              | string                   | Required | values: "ahrefs", "google\_search\_console", "bing\_webmaster\_tools", "semrush", "majestic", "moz", "dataforseo", "linkody", "csv"                                                                                                                                                                                                                                                          |
  | `items[].provider_metrics.imported.supplier_row_id`                       | string / null            | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `items[].provider_metrics.imported.supplier_generated_at`                 | string / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics.imported.supplier_metrics`                      | object / null            | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics.linktrail_corpus`                               | object                   | Required | additional fields rejected                                                                                                                                                                                                                                                                                                                                                                   |
  | `items[].provider_metrics.linktrail_corpus.source_outlink_count`          | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics.linktrail_corpus.source_external_outlink_count` | integer / null           | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].provider_metrics.linktrail_corpus.fetch_kind`                    | string                   | Required | values: "direct", "rendered", "proxied"                                                                                                                                                                                                                                                                                                                                                      |
  | `items[].provider_metrics.linktrail_corpus.extraction_complete`           | boolean                  | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].verification_status`                                             | string                   | Required | AgentLinkOps check state, independent of supplier flags. not\_checked means no AgentLinkOps check is recorded. values: "not\_checked", "present", "absent", "unknown", "source\_unavailable"                                                                                                                                                                                                 |
  | `items[].verified_at`                                                     | string / null            | Required | Timestamp of the AgentLinkOps check; null until checked.                                                                                                                                                                                                                                                                                                                                     |
  | `items[].observation_id`                                                  | string / null            | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `items[].inventory_id`                                                    | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `items[].set_id`                                                          | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `items[].set_revision`                                                    | number                   | Required |                                                                                                                                                                                                                                                                                                                                                                                              |
  | `items[].member_id`                                                       | string                   | Required | Identifier returned by the related operation.                                                                                                                                                                                                                                                                                                                                                |
  | `items[].member_role`                                                     | string                   | 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.                                                                                                                                                                                                                                                                                                                        |
</Accordion>

[Download input schema](/schemas/get_competitor_gap_report.input.json) · [Download output schema](/schemas/get_competitor_gap_report.output.json)

## 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](/reference/errors) 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](/reference/http/routes).

| Method and route                              | Success | Details                                       |
| --------------------------------------------- | ------- | --------------------------------------------- |
| `POST /v1/competitor-sets/{setId}/gap-report` | 200     | Remaining arguments go in a JSON object body. |

## Continue

[list\_competitor\_inventory\_rows](/reference/commands/list_competitor_inventory_rows)

Follow the [related workflow](/guides/competitor-research), inspect [capability status](/capability-status), or return to the [command index](/reference/index).
