request_domain_overview

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

post/v1/discovery/overviews

Request

  • Base URL: https://app.agentlinkops.com
  • URL: https://app.agentlinkops.com/v1/discovery/overviews
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

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

projectIdstring required

project ID from create/list.

targetstring required

Exact URL or domain to query, interpreted according to targetKind.

includeSubdomainsboolean required

Include subdomains of the selected domain in this query.

includeIndirectLinksboolean required

Include indirect supplier-reported links where supported.

excludeInternalBacklinksboolean required

Exclude supplier rows linking within the queried site.

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

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

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.

operation'domain_overview' required
provider'linktrail_corpus' | 'dataforseo' | 'imported' required
data_mode'synthetic' | 'owned_corpus' | 'provider_index' | 'imported' required
status'queued' | 'running' | 'succeeded' | '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
error_codestring nullable required

Latest delivery detail code; null when no failure or retry has been recorded.

coveragestring required

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

coverage_scope'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.