> ## 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.
# Capture competitor inventory
> Freeze one terminal, previously bound discovery run into an immutable 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.
Hosted MCP registration verified. These schemas describe the development contract; confirm supported inputs with tools/list. Generic CLI/HTTP calls require a matching development server. Configure LINKTRAIL\_API\_URL; production does not expose these command routes.
| Access | Behavior |
| ----------------- | --------------------- |
| `discovery:write` | Writes or admits work |
Reading saved data does not start a verification job. Mutations can change saved records or access; the effects below apply.
## 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.
```json MCP theme={null}
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "capture_competitor_inventory",
"arguments": {
"runId": "run_example"
}
}
}
```
```bash CLI theme={null}
linktrail call capture_competitor_inventory --args '{"runId":"run_example"}'
```
```bash HTTP theme={null}
curl "$LINKTRAIL_API_URL/v1/commands/capture_competitor_inventory" \
-H "Authorization: Bearer $LINKTRAIL_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.
```json theme={null}
{
"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](/reference/schemas) explain evidence states, empty lists and extensions.
| Field | Type | Presence | Meaning and constraints |
| ------------------------------------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `v` | number | Required | v recorded for this result. |
| `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 | set id recorded for this result. |
| `set_revision` | number | Required | set revision recorded for this result. |
| `set_hash` | string | Required | set hash recorded for this result. |
| `member_id` | string | Required | member id recorded for this result. |
| `member_role` | string | Required | member role recorded for this result. |
| `target_scope_id` | string | Required | target scope id recorded for this result. |
| `captured_at` | string | Required | captured at recorded for this result. |
| `provider_retrieved_from` | string / null | Required | provider retrieved from recorded for this result. |
| `provider_retrieved_to` | string / null | Required | provider retrieved to recorded for this result. |
| `run` | object | Required | run recorded for this result. |
| `run.v` | number | Required | v recorded for this result. 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 | provider recorded for this result. values: "linktrail\_corpus", "dataforseo", "imported" |
| `run.data_mode` | string | Required | data mode recorded for this result. values: "synthetic", "owned\_corpus", "provider\_index", "imported" |
| `run.query` | object | Required | query recorded for this result. additional fields rejected |
| `run.query.target_kind` | string | Required | target kind recorded for this result. values: "domain", "exact\_url" |
| `run.query.target` | string | Required | target recorded for this result. minLength: 1; maxLength: 4096 |
| `run.query.include_subdomains` | boolean | Required | include subdomains recorded for this result. |
| `run.query.backlinks_status_type` | string | Required | backlinks status type recorded for this result. values: "live", "lost", "all" |
| `run.query.exclude_internal_backlinks` | boolean | Required | exclude internal backlinks recorded for this result. |
| `run.query.mode` | string | Required | mode recorded for this result. must equal "as\_is" |
| `run.query.filters` | null | Required | filters recorded for this result. |
| `run.query.order_by` | array | Required | order by recorded for this result. minItems: 1; maxItems: 1 |
| `run.query.rank_scale` | string / null | Required | rank scale recorded for this result. |
| `run.query.page_limit` | integer | Required | page limit recorded for this result. minimum: 1; maximum: 1000 |
| `run.query.row_limit` | integer | Required | row limit recorded for this result. 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 | started at recorded for this result. |
| `run.finished_at` | string / null | Required | finished at recorded for this result. |
| `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 | coverage reason recorded for this result. |
| `run.provider_total_count` | integer / null | Required | provider total count recorded for this result. |
| `run.usage` | object | Required | usage recorded for this result. additional fields rejected |
| `run.usage.unit` | string | Required | unit recorded for this result. must equal "discovery" |
| `run.usage.currency` | string | Required | currency recorded for this result. must equal "USD" |
| `run.usage.quote_id` | string | Required | quote id recorded for this result. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$" |
| `run.usage.max_cost_microusd` | integer | Required | max cost microusd recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `run.usage.reserved_cost_microusd` | integer | Required | reserved cost microusd recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `run.usage.provider_reported_cost_microusd` | integer / null | Required | provider reported cost microusd recorded for this result. |
| `run.usage.request_count` | integer | Required | request count recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `run.usage.returned_rows` | integer | Required | returned rows recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `run.usage.accepted_candidates` | integer | Required | accepted candidates recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `run.usage.rejected_rows` | integer | Required | rejected rows recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `run.usage.duplicate_rows` | integer | Required | duplicate rows recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `run.operation` | string | Required | operation recorded for this result. must equal "backlinks" |
| `run.coverage_scope` | string | Required | coverage scope recorded for this result. 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 | content hash recorded for this result. |
| `absence_claim` | string | Required | not\_supported: missing dataset rows cannot prove link absence. must equal "not\_supported" |
| `verification_view` | string | Required | verification view recorded for this result. must equal "captured\_at\_snapshot" |
| `replayed` | boolean | Optional | True when the response reuses an earlier request with the same idempotency value. |
[Download input schema](/schemas/capture_competitor_inventory.input.json) · [Download output schema](/schemas/capture_competitor_inventory.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-inventories` | 201 | Remaining arguments go in a JSON object body. |
## Continue
[list\_competitor\_inventories](/reference/commands/list_competitor_inventories)
Follow the [related workflow](/guides/competitor-research), inspect [capability status](/capability-status), or return to the [command index](/reference/index).