---
title: "get_domain_overview"
method: GET
path: "/v1/discovery/overviews/{runId}"
---

# get_domain_overview

`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

Remaining read arguments go in query parameters.

## Path parameters

- `runId` string, required: run ID from create/list.

## Headers

- `X-Workspace-ID` string

## Response `200`

Remaining read arguments go in query parameters.

- object
  - `v` 1, 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.
  - `operation` 'domain_overview', required
  - `provider` 'linktrail_corpus' | 'dataforseo' | 'imported', required
  - `data_mode` 'synthetic' | 'owned_corpus' | 'provider_index' | 'imported', required
  - `query` object, required
    - `target` string, required
    - `include_subdomains` boolean, required
    - `include_indirect_links` boolean, required
    - `exclude_internal_backlinks` boolean, required
    - `backlinks_status_type` 'live' | 'lost' | 'all', required
    - `backlinks_filters` unknown, required
    - `rank_scale` 'one_thousand', nullable, required
    - `internal_list_limit` 10, required
  - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'reconciliation_required', required: Resource lifecycle status.
  - `created_at` string, date-time, required: UTC timestamp when the record was created.
  - `started_at` string, date-time, nullable, required
  - `finished_at` string, date-time, nullable, required
  - `error_code` string, nullable, required: Latest delivery detail code; null when no failure or retry has been recorded.
  - `usage` object, required
    - `unit` 'domain_overview', required
    - `currency` 'USD', required
    - `quote_id` string, required
    - `max_cost_microusd` integer, required
    - `reserved_cost_microusd` integer, required
    - `provider_reported_cost_microusd` integer, nullable, required
    - `request_count` integer, required
    - `summaries_returned` integer, required
  - `result` object, nullable, required: Saved result; null when this operation has no completed result.
    - `v` 1, required
    - `overview_run_id` string, required
    - `workspace_id` string, required: Workspace that owns this record.
    - `project_id` string, required: Project that owns this record.
    - `provider` 'linktrail_corpus' | 'dataforseo' | 'imported', required
    - `data_mode` 'synthetic' | 'owned_corpus' | 'provider_index' | 'imported', required
    - `provider_retrieved_at` string, date-time, required: Timestamp when the upstream evidence was retrieved.
    - `provider_first_seen` string, date-time, nullable, required
    - `provider_lost_date` string, date-time, nullable, required
    - `verified_at` unknown, required
    - `coverage` 'provider_summary' | 'corpus_subset' | 'partial', required: Dataset scope and completeness, including limits on what these results establish.
    - `counts` object, required
      - `backlinks` integer, nullable, required
      - `referring_domains` integer, nullable, required
      - `referring_main_domains` integer, nullable, required
      - `referring_pages` integer, nullable, required
      - `referring_ips` integer, nullable, required
      - `referring_subnets` integer, nullable, required
      - `crawled_pages` integer, nullable, required
      - `broken_backlinks` integer, nullable, required
      - `broken_pages` integer, nullable, required
    - `provider_metrics` union, required
      - object
        - `dataforseo` object, required
          - `rank` integer, nullable, required
          - `backlinks_spam_score` integer, nullable, required
          - `rank_scale` 'one_thousand', required
      - object
        - `linktrail_corpus` object, required
          - `corpus_source_pages` integer, nullable, required
          - `corpus_last_expanded_at` string, date-time, nullable, required
  - `coverage` string, required: Dataset scope and completeness, including limits on what these results establish.
  - `coverage_scope` 'provider_query', required
  - `whole_web_coverage` false, required: False: these results do not measure the whole web.
  - `replayed` boolean: True when the response reuses an earlier request with the same idempotency value.

## Other responses

- `429`: Request-rate or usage refusal. Inspect error.code and recovery details before retrying.
- `default`: Error envelope. Non-configuration 5xx messages are masked and details omitted; allowlisted configuration errors retain static operator recovery.

---

[API](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api.md) · [All operations](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/revisions/1bf30c2912b2?raw)