Capture competitor inventory

capture_competitor_inventory Freeze one terminal, previously bound discovery run into an immutable inventory. Requires a previously bound terminal run; an arbitrary imported run is not a competitor inventory. Works with retained data when new discovery admission is disabled. Reads only stored evidence; never purchases a query or checks links.

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

Access	Behavior
`discovery:write`	Writes or admits work

This operation changes saved state. Review its inputs and retry behavior before calling.

Example request

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

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "capture_competitor_inventory",
    "arguments": {
      "runId": "run_example"
    }
  }
}

agentlinkops call capture_competitor_inventory --args '{"runId":"run_example"}'

curl "$AGENTLINKOPS_API_URL/v1/commands/capture_competitor_inventory" \
  -H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"runId":"run_example"}'

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.

Full response example

{
  "v": 1,
  "id": "ci_example",
  "workspace_id": "ws_example",
  "project_id": "pr_example",
  "set_id": "cs_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": "run_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",
  "replayed": false
}

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
`runId`	string	Required	Identifier of the run returned by its create or list operation. minLength: 1; maxLength: 200

Validation and omitted values

The run must already be bound to the approved competitor member and reach a terminal state. Arbitrary imported runs cannot be captured as competitor inventories.

Output fields

Fields inside optional or nullable parents apply only when that parent exists. Common schema conventions explain evidence states, empty lists and extensions.

v (number, required).
id (string, required): Resource identifier returned by the operation.
workspace_id (string, required): Workspace that owns this record.
project_id (string, required): Project that owns this record.
set_id (string, required): Identifier returned by the related operation.
set_revision (number, required).
set_hash (string, required).
member_id (string, required): Identifier returned by the related operation.
member_role (string, required).
target_scope_id (string, required): Identifier returned by the related operation.
captured_at (string, required).
provider_retrieved_from (string / null, required).
provider_retrieved_to (string / null, required).
run (object, required).
content_hash (string, required).
absence_claim (string, required): not_supported: missing dataset rows cannot prove link absence. must equal “not_supported”
verification_view (string, required): must equal “captured_at_snapshot”
replayed (boolean, optional): True when the response reuses an earlier request with the same idempotency value.

All fields and nested objects

Field	Type	Presence	Meaning and constraints
`v`	number	Required
`id`	string	Required	Resource identifier returned by the operation.
`workspace_id`	string	Required	Workspace that owns this record.
`project_id`	string	Required	Project that owns this record.
`set_id`	string	Required	Identifier returned by the related operation.
`set_revision`	number	Required
`set_hash`	string	Required
`member_id`	string	Required	Identifier returned by the related operation.
`member_role`	string	Required
`target_scope_id`	string	Required	Identifier returned by the related operation.
`captured_at`	string	Required
`provider_retrieved_from`	string / null	Required
`provider_retrieved_to`	string / null	Required
`run`	object	Required
`run.v`	number	Required	must equal 1
`run.id`	string	Required	Resource identifier returned by the operation. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“
`run.workspace_id`	string	Required	Workspace that owns this record. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“
`run.project_id`	string	Required	Project that owns this record. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“
`run.provider`	string	Required	values: “linktrail_corpus”, “dataforseo”, “imported”
`run.data_mode`	string	Required	values: “synthetic”, “owned_corpus”, “provider_index”, “imported”
`run.query`	object	Required	additional fields rejected
`run.query.target_kind`	string	Required	values: “domain”, “exact_url”
`run.query.target`	string	Required	minLength: 1; maxLength: 4096
`run.query.include_subdomains`	boolean	Required
`run.query.backlinks_status_type`	string	Required	values: “live”, “lost”, “all”
`run.query.exclude_internal_backlinks`	boolean	Required
`run.query.mode`	string	Required	must equal “as_is”
`run.query.filters`	null	Required
`run.query.order_by`	array	Required	minItems: 1; maxItems: 1
`run.query.rank_scale`	string / null	Required
`run.query.page_limit`	integer	Required	minimum: 1; maximum: 1000
`run.query.row_limit`	integer	Required	minimum: 1; maximum: 1000
`run.status`	string	Required	Resource lifecycle status. values: “queued”, “running”, “succeeded”, “partial”, “failed”, “reconciliation_required”
`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))$“
`run.started_at`	string / null	Required
`run.finished_at`	string / null	Required
`run.coverage`	string	Required	Dataset scope and completeness, including limits on what these results establish. values: “pending”, “complete_for_query”, “capped”, “partial”, “unknown”
`run.coverage_reason`	string / null	Required
`run.provider_total_count`	integer / null	Required
`run.usage`	object	Required	additional fields rejected
`run.usage.unit`	string	Required	must equal “discovery”
`run.usage.currency`	string	Required	must equal “USD”
`run.usage.quote_id`	string	Required	Identifier returned by the related operation. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“
`run.usage.max_cost_microusd`	integer	Required	minimum: 0; maximum: 9007199254740991
`run.usage.reserved_cost_microusd`	integer	Required	minimum: 0; maximum: 9007199254740991
`run.usage.provider_reported_cost_microusd`	integer / null	Required
`run.usage.request_count`	integer	Required	minimum: 0; maximum: 9007199254740991
`run.usage.returned_rows`	integer	Required	minimum: 0; maximum: 9007199254740991
`run.usage.accepted_candidates`	integer	Required	minimum: 0; maximum: 9007199254740991
`run.usage.rejected_rows`	integer	Required	minimum: 0; maximum: 9007199254740991
`run.usage.duplicate_rows`	integer	Required	minimum: 0; maximum: 9007199254740991
`run.operation`	string	Required	must equal “backlinks”
`run.coverage_scope`	string	Required	values: “customer_import”, “corpus_subset”, “provider_query”
`run.whole_web_coverage`	boolean	Required	False: these results do not measure the whole web. must equal false
`run.replayed`	boolean	Optional	True when the response reuses an earlier request with the same idempotency value.
`content_hash`	string	Required
`absence_claim`	string	Required	not_supported: missing dataset rows cannot prove link absence. must equal “not_supported”
`verification_view`	string	Required	must equal “captured_at_snapshot”
`replayed`	boolean	Optional	True when the response reuses an earlier request with the same idempotency value.

Download input schema · Download output schema

Errors and retries

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

HTTP resource routes

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

Method and route	Success	Details
`POST /v1/competitor-inventories`	201	Remaining arguments go in a JSON object body.

Continue

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

Overview

MCP, CLI and API commands

CLI client

HTTP and events

Optional local workflows

Capture competitor inventory

Example request

Returned result

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue

​Example request

​Returned result

​Input fields

​Validation and omitted values

​Output fields

​Errors and retries

​HTTP resource routes

​Continue

Example request

Returned result

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue