request_competitor_inventory

Remaining arguments go in a JSON object body. Supply idempotencyKey as the Idempotency-Key header on this resource route.

post/v1/competitor-sets/{setId}/runs

Request

  • Base URL: https://app.agentlinkops.com
  • URL: https://app.agentlinkops.com/v1/competitor-sets/{setId}/runs
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

setIdstring required

set ID from create/list.

Headers

Idempotency-Keystring required

Caller-generated key reused only for retries of the same operation and arguments in this workspace.

X-Workspace-IDstring

Required when using a Clerk human session. With an API key, omit this header or supply its bound workspace.

Request body

revisioninteger required

Immutable set revision to read/compare.

memberIdstring required

member ID from create/list.

backlinksStatus'live' | 'lost' | 'all' required

Supplier-reported backlink status filter; this is not AgentLinkOps verification.

excludeInternalBacklinksboolean required

Exclude supplier rows linking within the queried site.

pageLimitinteger required

Maximum supplier rows requested per page, within the total row limit.

rowLimitinteger required

Maximum total supplier rows admitted for this discovery run.

Response

Remaining arguments go in a JSON object body. Supply idempotencyKey as the Idempotency-Key header on this resource route.

v1 required
idstring required

Resource identifier returned by the operation.

workspace_idstring required

Workspace that owns this record.

project_idstring required

Project that owns this record.

provider'linktrail_corpus' | 'dataforseo' | 'imported' required
data_mode'synthetic' | 'owned_corpus' | 'provider_index' | 'imported' required
status'queued' | 'running' | 'succeeded' | 'partial' | 'failed' | 'reconciliation_required' required

Resource lifecycle status.

created_atstring date-time required

UTC timestamp when the record was created.

started_atstring date-time nullable required
finished_atstring date-time nullable required
coverage'pending' | 'complete_for_query' | 'capped' | 'partial' | 'unknown' required

Dataset scope and completeness, including limits on what these results establish.

coverage_reasonstring nullable required
provider_total_countinteger nullable required
operation'backlinks' required
coverage_scope'customer_import' | 'corpus_subset' | 'provider_query' required
whole_web_coveragefalse required

False: these results do not measure the whole web.

replayedboolean

True when the response reuses an earlier request with the same idempotency value.

Changes

No recorded changes to this operation across all 1 revision of this API.