v | number | Required | |
report_hash | string | Required | |
set_id | string | Required | Identifier returned by the related operation. |
set_revision | number | Required | |
grouping | string | Required | |
comparison | object | Required | |
comparison.mode | string | Required | |
comparison.reasons | array | Required | |
comparison.absence_claim | string | Required | not_supported: missing dataset rows cannot prove link absence. must equal “not_supported” |
absence_claim | string | Required | not_supported: missing dataset rows cannot prove link absence. must equal “not_supported” |
whole_web_coverage | boolean | Required | False: these results do not measure the whole web. must equal false |
coverage_scope | string | Required | |
verification_view | string | Required | |
max_retrieval_skew_ms | number | Required | |
selected_inventory_ids | array | Required | |
unselected_member_ids | array | Required | |
exclusions | object | Required | |
exclusions.scope | string | Required | |
exclusions.policy | string | Required | |
exclusions.rules | array | Required | |
exclusions.rules[].grouping | string | Required | values: “page”, “source_host” |
exclusions.rules[].value | string | Required | |
exclusions.saved_revision | number | Optional | |
exclusions.set_revision_at_save | number | Optional | |
inventories | array | Required | |
inventories[].v | number | Required | |
inventories[].id | string | Required | Resource identifier returned by the operation. |
inventories[].workspace_id | string | Required | Workspace that owns this record. |
inventories[].project_id | string | Required | Project that owns this record. |
inventories[].set_id | string | Required | Identifier returned by the related operation. |
inventories[].set_revision | number | Required | |
inventories[].set_hash | string | Required | |
inventories[].member_id | string | Required | Identifier returned by the related operation. |
inventories[].member_role | string | Required | |
inventories[].target_scope_id | string | Required | Identifier returned by the related operation. |
inventories[].captured_at | string | Required | |
inventories[].provider_retrieved_from | string / null | Required | |
inventories[].provider_retrieved_to | string / null | Required | |
inventories[].run | object | Required | |
inventories[].run.v | number | Required | must equal 1 |
inventories[].run.id | string | Required | Resource identifier returned by the operation. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“ |
inventories[].run.workspace_id | string | Required | Workspace that owns this record. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“ |
inventories[].run.project_id | string | Required | Project that owns this record. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“ |
inventories[].run.provider | string | Required | values: “linktrail_corpus”, “dataforseo”, “imported” |
inventories[].run.data_mode | string | Required | values: “synthetic”, “owned_corpus”, “provider_index”, “imported” |
inventories[].run.query | object | Required | additional fields rejected |
inventories[].run.query.target_kind | string | Required | values: “domain”, “exact_url” |
inventories[].run.query.target | string | Required | minLength: 1; maxLength: 4096 |
inventories[].run.query.include_subdomains | boolean | Required | |
inventories[].run.query.backlinks_status_type | string | Required | values: “live”, “lost”, “all” |
inventories[].run.query.exclude_internal_backlinks | boolean | Required | |
inventories[].run.query.mode | string | Required | must equal “as_is” |
inventories[].run.query.filters | null | Required | |
inventories[].run.query.order_by | array | Required | minItems: 1; maxItems: 1 |
inventories[].run.query.rank_scale | string / null | Required | |
inventories[].run.query.page_limit | integer | Required | minimum: 1; maximum: 1000 |
inventories[].run.query.row_limit | integer | Required | minimum: 1; maximum: 1000 |
inventories[].run.status | string | Required | Resource lifecycle status. values: “queued”, “running”, “succeeded”, “partial”, “failed”, “reconciliation_required” |
inventories[].run.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))$“ |
inventories[].run.started_at | string / null | Required | |
inventories[].run.finished_at | string / null | Required | |
inventories[].run.coverage | string | Required | Dataset scope and completeness, including limits on what these results establish. values: “pending”, “complete_for_query”, “capped”, “partial”, “unknown” |
inventories[].run.coverage_reason | string / null | Required | |
inventories[].run.provider_total_count | integer / null | Required | |
inventories[].run.usage | object | Required | additional fields rejected |
inventories[].run.usage.unit | string | Required | must equal “discovery” |
inventories[].run.usage.currency | string | Required | must equal “USD” |
inventories[].run.usage.quote_id | string | Required | Identifier returned by the related operation. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“ |
inventories[].run.usage.max_cost_microusd | integer | Required | minimum: 0; maximum: 9007199254740991 |
inventories[].run.usage.reserved_cost_microusd | integer | Required | minimum: 0; maximum: 9007199254740991 |
inventories[].run.usage.provider_reported_cost_microusd | integer / null | Required | |
inventories[].run.usage.request_count | integer | Required | minimum: 0; maximum: 9007199254740991 |
inventories[].run.usage.returned_rows | integer | Required | minimum: 0; maximum: 9007199254740991 |
inventories[].run.usage.accepted_candidates | integer | Required | minimum: 0; maximum: 9007199254740991 |
inventories[].run.usage.rejected_rows | integer | Required | minimum: 0; maximum: 9007199254740991 |
inventories[].run.usage.duplicate_rows | integer | Required | minimum: 0; maximum: 9007199254740991 |
inventories[].run.operation | string | Required | must equal “backlinks” |
inventories[].run.coverage_scope | string | Required | values: “customer_import”, “corpus_subset”, “provider_query” |
inventories[].run.whole_web_coverage | boolean | Required | False: these results do not measure the whole web. must equal false |
inventories[].run.replayed | boolean | Optional | True when the response reuses an earlier request with the same idempotency value. |
inventories[].content_hash | string | Required | |
inventories[].absence_claim | string | Required | not_supported: missing dataset rows cannot prove link absence. must equal “not_supported” |
inventories[].verification_view | string | Required | must equal “captured_at_snapshot” |
inventories[].replayed | boolean | Optional | True when the response reuses an earlier request with the same idempotency value. |
counts | object / null | Required | |
counts.groups | number | Required | |
counts.rows | number | Required | |
counts.observed_overlap_groups | number | Required | |
counts.dataset_gap_groups | number / null | Required | |
counts.comparison_unknown_groups | number | Required | |
counts.excluded_groups | number | Required | |
counts.excluded_rows | number | Required | |
view | string | Required | values: “groups”, “rows” |
group | object | Optional | |
group.key | string | Required | Saved lookup identifier within this record. |
group.relation | string | Required | |
group.competitor_count | number | Required | |
group.row_count | number | Required | |
group.customer_row_count | number | Required | |
group.competitor_row_count | number | Required | |
group.contributors | array | Required | |
group.contributors[].member_id | string | Required | Identifier returned by the related operation. |
group.contributors[].member_role | string | Required | |
group.contributors[].inventory_id | string | Required | Identifier returned by the related operation. |
group.contributors[].row_count | number | Required | |
items | array | Required | Records in this bounded page. |
items[].key | string | Required | Saved lookup identifier within this record. |
items[].relation | string | Required | |
items[].competitor_count | number | Required | |
items[].row_count | number | Required | |
items[].customer_row_count | number | Required | |
items[].competitor_row_count | number | Required | |
items[].contributors | array | Required | |
items[].contributors[].member_id | string | Required | Identifier returned by the related operation. |
items[].contributors[].member_role | string | Required | |
items[].contributors[].inventory_id | string | Required | Identifier returned by the related operation. |
items[].contributors[].row_count | number | Required | |
items[].v | number | Required | must equal 1 |
items[].id | string | Required | Resource identifier returned by the operation. pattern: “^dc_[a-f0-9]{64}$“ |
items[].workspace_id | string | Required | Workspace that owns this record. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“ |
items[].project_id | string | Required | Project that owns this record. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“ |
items[].discovery_run_id | string | Required | Identifier returned by the related operation. minLength: 1; maxLength: 128; pattern: ”^[a-zA-Z0-9_-]+$“ |
items[].source_url | string | Required | Publisher page URL recorded in this evidence. maxLength: 4096 |
items[].target_url | string | Required | Destination URL recorded in this evidence. maxLength: 4096 |
items[].provider | string | Required | values: “linktrail_corpus”, “dataforseo”, “imported” |
items[].data_mode | string | Required | values: “synthetic”, “owned_corpus”, “provider_index”, “imported” |
items[].provider_retrieved_at | string | Required | Timestamp when the upstream evidence was retrieved. 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))$“ |
items[].provider_first_seen | string / null | Required | |
items[].provider_prev_seen | string / null | Required | |
items[].provider_last_seen | string / null | Required | |
items[].provider_status | object | Required | additional fields rejected |
items[].provider_status.is_lost | boolean / null | Required | |
items[].provider_status.is_broken | boolean / null | Required | |
items[].provider_status.is_new | boolean / null | Required | |
items[].anchor | string / null | Required | |
items[].rel | array / null | Required | |
items[].dofollow | boolean / null | Required | |
items[].link_type | string / null | Required | |
items[].source_http_status | integer / null | Required | |
items[].target_http_status | integer / null | Required | |
items[].links_count | integer / null | Required | |
items[].provider_metrics | object / object / object | Required | |
items[].provider_metrics.dataforseo | object | Required | additional fields rejected |
items[].provider_metrics.dataforseo.rank | integer / null | Required | |
items[].provider_metrics.dataforseo.page_from_rank | integer / null | Required | |
items[].provider_metrics.dataforseo.domain_from_rank | integer / null | Required | |
items[].provider_metrics.dataforseo.backlink_spam_score | integer / null | Required | |
items[].provider_metrics.dataforseo.rank_scale | string | Required | must equal “one_thousand” |
items[].provider_metrics.imported | object | Required | additional fields rejected |
items[].provider_metrics.imported.supplier | string | Required | values: “ahrefs”, “google_search_console”, “bing_webmaster_tools”, “semrush”, “majestic”, “moz”, “dataforseo”, “linkody”, “csv” |
items[].provider_metrics.imported.supplier_row_id | string / null | Required | Identifier returned by the related operation. |
items[].provider_metrics.imported.supplier_generated_at | string / null | Required | |
items[].provider_metrics.imported.supplier_metrics | object / null | Required | |
items[].provider_metrics.linktrail_corpus | object | Required | additional fields rejected |
items[].provider_metrics.linktrail_corpus.source_outlink_count | integer / null | Required | |
items[].provider_metrics.linktrail_corpus.source_external_outlink_count | integer / null | Required | |
items[].provider_metrics.linktrail_corpus.fetch_kind | string | Required | values: “direct”, “rendered”, “proxied” |
items[].provider_metrics.linktrail_corpus.extraction_complete | boolean | Required | |
items[].verification_status | string | Required | AgentLinkOps check state, independent of supplier flags. not_checked means no AgentLinkOps check is recorded. values: “not_checked”, “present”, “absent”, “unknown”, “source_unavailable” |
items[].verified_at | string / null | Required | Timestamp of the AgentLinkOps check; null until checked. |
items[].observation_id | string / null | Required | Identifier returned by the related operation. |
items[].inventory_id | string | Required | Identifier returned by the related operation. |
items[].set_id | string | Required | Identifier returned by the related operation. |
items[].set_revision | number | Required | |
items[].member_id | string | Required | Identifier returned by the related operation. |
items[].member_role | string | Required | |
has_more | boolean | Required | True when another page is available. |
next_cursor | string / null | Required | Opaque continuation for the same listing; null means no further page. |