> ## 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.
# List competitor inventories
> List dated inventory summaries for one approved set revision.
`list_competitor_inventories`
List dated inventory summaries for one approved set revision. Requires revision, available from get\_competitor\_set. Works with saved inventories when new admission is disabled. Missing edges are not confirmed absence.
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:read` | Reads saved data |
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": "list_competitor_inventories",
"arguments": {
"setId": "set_example",
"revision": 1
}
}
}
```
```bash CLI theme={null}
linktrail call list_competitor_inventories --args '{"setId":"set_example","revision":1}'
```
```bash HTTP theme={null}
curl "$LINKTRAIL_API_URL/v1/commands/list_competitor_inventories" \
-H "Authorization: Bearer $LINKTRAIL_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"setId":"set_example","revision":1}'
```
## 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}
{
"items": [
{
"v": 1,
"id": "ci_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"
}
],
"next_cursor": null,
"has_more": 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 |
| ---------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `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 |
| `memberId` | string | Optional | Identifier of the member returned by its create or list operation. minLength: 1; maxLength: 200 |
| `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.
Pages are ordered by stored identifier ascending, not by observation freshness.
Omitting memberId includes all members of the requested set revision.
### Defaults when omitted
| Field | Default |
| ------- | ------- |
| `limit` | `50` |
## 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 |
| --------------------------------------------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `items` | array | Required | Records in this bounded page. |
| `items[].v` | number | Required | v recorded for this result. |
| `items[].id` | string | Required | Resource identifier returned by the operation. |
| `items[].workspace_id` | string | Required | Workspace that owns this record. |
| `items[].project_id` | string | Required | Project that owns this record. |
| `items[].set_id` | string | Required | set id recorded for this result. |
| `items[].set_revision` | number | Required | set revision recorded for this result. |
| `items[].set_hash` | string | Required | set hash recorded for this result. |
| `items[].member_id` | string | Required | member id recorded for this result. |
| `items[].member_role` | string | Required | member role recorded for this result. |
| `items[].target_scope_id` | string | Required | target scope id recorded for this result. |
| `items[].captured_at` | string | Required | captured at recorded for this result. |
| `items[].provider_retrieved_from` | string / null | Required | provider retrieved from recorded for this result. |
| `items[].provider_retrieved_to` | string / null | Required | provider retrieved to recorded for this result. |
| `items[].run` | object | Required | run recorded for this result. |
| `items[].run.v` | number | Required | v recorded for this result. must equal 1 |
| `items[].run.id` | string | Required | Resource identifier returned by the operation. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$" |
| `items[].run.workspace_id` | string | Required | Workspace that owns this record. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$" |
| `items[].run.project_id` | string | Required | Project that owns this record. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$" |
| `items[].run.provider` | string | Required | provider recorded for this result. values: "linktrail\_corpus", "dataforseo", "imported" |
| `items[].run.data_mode` | string | Required | data mode recorded for this result. values: "synthetic", "owned\_corpus", "provider\_index", "imported" |
| `items[].run.query` | object | Required | query recorded for this result. additional fields rejected |
| `items[].run.query.target_kind` | string | Required | target kind recorded for this result. values: "domain", "exact\_url" |
| `items[].run.query.target` | string | Required | target recorded for this result. minLength: 1; maxLength: 4096 |
| `items[].run.query.include_subdomains` | boolean | Required | include subdomains recorded for this result. |
| `items[].run.query.backlinks_status_type` | string | Required | backlinks status type recorded for this result. values: "live", "lost", "all" |
| `items[].run.query.exclude_internal_backlinks` | boolean | Required | exclude internal backlinks recorded for this result. |
| `items[].run.query.mode` | string | Required | mode recorded for this result. must equal "as\_is" |
| `items[].run.query.filters` | null | Required | filters recorded for this result. |
| `items[].run.query.order_by` | array | Required | order by recorded for this result. minItems: 1; maxItems: 1 |
| `items[].run.query.rank_scale` | string / null | Required | rank scale recorded for this result. |
| `items[].run.query.page_limit` | integer | Required | page limit recorded for this result. minimum: 1; maximum: 1000 |
| `items[].run.query.row_limit` | integer | Required | row limit recorded for this result. minimum: 1; maximum: 1000 |
| `items[].run.status` | string | Required | Resource lifecycle status. values: "queued", "running", "succeeded", "partial", "failed", "reconciliation\_required" |
| `items[].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))\$" |
| `items[].run.started_at` | string / null | Required | started at recorded for this result. |
| `items[].run.finished_at` | string / null | Required | finished at recorded for this result. |
| `items[].run.coverage` | string | Required | Dataset scope and completeness, including limits on what these results establish. values: "pending", "complete\_for\_query", "capped", "partial", "unknown" |
| `items[].run.coverage_reason` | string / null | Required | coverage reason recorded for this result. |
| `items[].run.provider_total_count` | integer / null | Required | provider total count recorded for this result. |
| `items[].run.usage` | object | Required | usage recorded for this result. additional fields rejected |
| `items[].run.usage.unit` | string | Required | unit recorded for this result. must equal "discovery" |
| `items[].run.usage.currency` | string | Required | currency recorded for this result. must equal "USD" |
| `items[].run.usage.quote_id` | string | Required | quote id recorded for this result. minLength: 1; maxLength: 128; pattern: "^\[a-zA-Z0-9\_-]+\$" |
| `items[].run.usage.max_cost_microusd` | integer | Required | max cost microusd recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `items[].run.usage.reserved_cost_microusd` | integer | Required | reserved cost microusd recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `items[].run.usage.provider_reported_cost_microusd` | integer / null | Required | provider reported cost microusd recorded for this result. |
| `items[].run.usage.request_count` | integer | Required | request count recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `items[].run.usage.returned_rows` | integer | Required | returned rows recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `items[].run.usage.accepted_candidates` | integer | Required | accepted candidates recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `items[].run.usage.rejected_rows` | integer | Required | rejected rows recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `items[].run.usage.duplicate_rows` | integer | Required | duplicate rows recorded for this result. minimum: 0; maximum: 9007199254740991 |
| `items[].run.operation` | string | Required | operation recorded for this result. must equal "backlinks" |
| `items[].run.coverage_scope` | string | Required | coverage scope recorded for this result. values: "customer\_import", "corpus\_subset", "provider\_query" |
| `items[].run.whole_web_coverage` | boolean | Required | False: these results do not measure the whole web. must equal false |
| `items[].run.replayed` | boolean | Optional | True when the response reuses an earlier request with the same idempotency value. |
| `items[].content_hash` | string | Required | content hash recorded for this result. |
| `items[].absence_claim` | string | Required | not\_supported: missing dataset rows cannot prove link absence. must equal "not\_supported" |
| `items[].verification_view` | string | Required | verification view recorded for this result. must equal "captured\_at\_snapshot" |
| `items[].replayed` | boolean | Optional | True when the response reuses an earlier request with the same idempotency value. |
| `next_cursor` | string / null | Required | Opaque continuation for the same listing; null means no further page. |
| `has_more` | boolean | Optional | True when another page is available. |
[Download input schema](/schemas/list_competitor_inventories.input.json) · [Download output schema](/schemas/list_competitor_inventories.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 |
| --------------------------------------------- | ------- | ------------------------------------------------ |
| `GET /v1/competitor-sets/{setId}/inventories` | 200 | Remaining read arguments go in query parameters. |
## Continue
[list\_competitor\_inventory\_rows](/reference/commands/list_competitor_inventory_rows) · [get\_competitor\_gap\_report](/reference/commands/get_competitor_gap_report)
Follow the [related workflow](/guides/competitor-research), inspect [capability status](/capability-status), or return to the [command index](/reference/index).