Request competitor inventory

request_competitor_inventory Look up one approved member/revision in the owned corpus. Candidates are unchecked; missing rows do not prove absence. No supplier spending or monitoring. If unconfigured, follow the error’s operator action; retries cannot configure it.

Name recorded in the 2026-10-17 deployment. This page describes current source; verify inputs and access in your connected catalog. Provider configuration and workspace access still apply.

Access	Behavior
`discovery:write`	Writes or admits work

Provider-backed admission requires enabled configuration and available allowance; registration alone does not make retrieval available. Inspect usage and the run’s coverage before interpreting results.

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": "request_competitor_inventory",
    "arguments": {
      "setId": "set_example",
      "revision": 1,
      "memberId": "member_example",
      "backlinksStatus": "live",
      "excludeInternalBacklinks": false,
      "pageLimit": 1,
      "rowLimit": 1,
      "idempotencyKey": "docs-request-001"
    }
  }
}

agentlinkops call request_competitor_inventory --args '{"setId":"set_example","revision":1,"memberId":"member_example","backlinksStatus":"live","excludeInternalBacklinks":false,"pageLimit":1,"rowLimit":1,"idempotencyKey":"docs-request-001"}'

curl --fail-with-body https://app.agentlinkops.com/v1/commands/request_competitor_inventory \
  -H "Authorization: Bearer $AGENTLINKOPS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"setId":"set_example","revision":1,"memberId":"member_example","backlinksStatus":"live","excludeInternalBacklinks":false,"pageLimit":1,"rowLimit":1,"idempotencyKey":"docs-request-001"}'

Returned result

Schema-validated example; IDs and dates are illustrative. MCP returns this data in structuredContent and in a text content block; generic HTTP and CLI return the JSON result directly.

Full response example

{
  "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": false,
    "mode": "as_is",
    "filters": null,
    "order_by": [
      "first_seen,desc"
    ],
    "rank_scale": null,
    "page_limit": 1,
    "row_limit": 1
  },
  "status": "queued",
  "created_at": "2026-09-13T12:00:00.000Z",
  "started_at": null,
  "finished_at": null,
  "coverage": "pending",
  "coverage_reason": null,
  "provider_total_count": null,
  "usage": {
    "unit": "discovery",
    "currency": "USD",
    "quote_id": "owned_example",
    "max_cost_microusd": 0,
    "reserved_cost_microusd": 0,
    "provider_reported_cost_microusd": null,
    "request_count": 0,
    "returned_rows": 0,
    "accepted_candidates": 0,
    "rejected_rows": 0,
    "duplicate_rows": 0
  },
  "operation": "backlinks",
  "coverage_scope": "corpus_subset",
  "whole_web_coverage": false,
  "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
`setId`	string	Required	set ID from create/list. minLength: `1`; maxLength: `200`
`revision`	integer	Required	Immutable set revision to read/compare. minimum: `1`; maximum: `9007199254740990`
`memberId`	string	Required	member ID from create/list. pattern: `"^[a-zA-Z0-9_-]{1,128}$"`
`backlinksStatus`	string	Required	Supplier-reported backlink status filter; this is not AgentLinkOps verification. values: `"live"`, `"lost"`, `"all"`
`excludeInternalBacklinks`	boolean	Required	Exclude supplier rows linking within the queried site.
`pageLimit`	integer	Required	Maximum supplier rows requested per page, within the total row limit. minimum: `1`; maximum: `1000`
`rowLimit`	integer	Required	Maximum total supplier rows admitted for this discovery run. minimum: `1`; maximum: `1000`
`idempotencyKey`	string	Required	Caller-generated key reused only for retries of the same operation and arguments in this workspace. pattern: `"^[\\x21-\\x7e]{1,200}$"`

Validation and omitted values

backlinksStatus, excludeInternalBacklinks, pageLimit and rowLimit are required explicit policies, with no omitted-input defaults. The member supplies the previously approved target scope. This operation needs configured owned-corpus admission. It does not accept an arbitrary provider field, buy supplier data or enroll monitoring.

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.
provider (string, required).
data_mode (string, required).
query (object, required).
status (string, required): Resource lifecycle status.
created_at (string, required): UTC timestamp when the record was created.
started_at (string / null, required).
finished_at (string / null, required).
coverage (string, required): Dataset scope and completeness, including limits on what these results establish.
coverage_reason (string / null, required).
provider_total_count (integer / null, required).
usage (object, required).
operation (string, required).
coverage_scope (string, required).
whole_web_coverage (boolean, required): False: these results do not measure the whole web.
replayed (boolean, optional): True when the response reuses an earlier request with the same idempotency value.

All fields and nested objects

Types, allowed values, limits and nested fields:

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

When retrying with idempotencyKey, reuse the original value and the same arguments; preserve originally omitted optional fields. Generic HTTP puts idempotencyKey in the JSON body, while resource routes use the header where listed below. A changed 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-sets/{setId}/runs`	202	Remaining arguments go in a JSON object body. Supply idempotencyKey as the Idempotency-Key header on this resource route.

Continue

get_discovery_run · capture_competitor_inventory Follow the related workflow. See capability status for availability or the command index for another operation.

Overview

MCP, CLI and API commands

CLI client

HTTP and events

Optional local workflows

Request 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