get_domain_overview

Remaining read arguments go in query parameters.

get/v1/discovery/overviews/{runId}

Request

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

Path parameters

runIdstring required

run ID from create/list.

Headers

X-Workspace-IDstring

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

Response

Remaining read arguments go in query parameters.

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.