v | number | Required | must equal 1 |
id | string | Required | Resource identifier returned by the operation. minLength: 1; maxLength: 128; pattern: "^[a-zA-Z0-9_-]+$" |
workspace_id | string | Required | Workspace that owns this record. minLength: 1; maxLength: 128; pattern: "^[a-zA-Z0-9_-]+$" |
project_id | string | Required | Project that owns this record. minLength: 1; maxLength: 128; pattern: "^[a-zA-Z0-9_-]+$" |
provider | string | Required | values: "linktrail_corpus", "dataforseo", "imported" |
data_mode | string | Required | values: "synthetic", "owned_corpus", "provider_index", "imported" |
query | object | Required | additional fields rejected |
query.target_kind | string | Required | values: "domain", "exact_url" |
query.target | string | Required | minLength: 1; maxLength: 4096 |
query.include_subdomains | boolean | Required | |
query.backlinks_status_type | string | Required | values: "live", "lost", "all" |
query.exclude_internal_backlinks | boolean | Required | |
query.mode | string | Required | must equal "as_is" |
query.filters | null | Required | |
query.order_by | array | Required | minItems: 1; maxItems: 1 |
query.rank_scale | string / null | Required | |
query.page_limit | integer | Required | minimum: 1; maximum: 1000 |
query.row_limit | integer | Required | minimum: 1; maximum: 1000 |
status | string | Required | Resource lifecycle status. values: "queued", "running", "succeeded", "partial", "failed", "reconciliation_required" |
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))$" |
started_at | string / null | Required | |
finished_at | string / null | Required | |
coverage | string | Required | Dataset scope and completeness, including limits on what these results establish. values: "pending", "complete_for_query", "capped", "partial", "unknown" |
coverage_reason | string / null | Required | |
provider_total_count | integer / null | Required | |
usage | object | Required | additional fields rejected |
usage.unit | string | Required | must equal "discovery" |
usage.currency | string | Required | must equal "USD" |
usage.quote_id | string | Required | Identifier returned by the related operation. minLength: 1; maxLength: 128; pattern: "^[a-zA-Z0-9_-]+$" |
usage.max_cost_microusd | integer | Required | minimum: 0; maximum: 9007199254740991 |
usage.reserved_cost_microusd | integer | Required | minimum: 0; maximum: 9007199254740991 |
usage.provider_reported_cost_microusd | integer / null | Required | |
usage.request_count | integer | Required | minimum: 0; maximum: 9007199254740991 |
usage.returned_rows | integer | Required | minimum: 0; maximum: 9007199254740991 |
usage.accepted_candidates | integer | Required | minimum: 0; maximum: 9007199254740991 |
usage.rejected_rows | integer | Required | minimum: 0; maximum: 9007199254740991 |
usage.duplicate_rows | integer | Required | minimum: 0; maximum: 9007199254740991 |
operation | string | Required | must equal "backlinks" |
coverage_scope | string | Required | values: "customer_import", "corpus_subset", "provider_query" |
whole_web_coverage | boolean | Required | False: these results do not measure the whole web. must equal false |
replayed | boolean | Optional | True when the response reuses an earlier request with the same idempotency value. |
admission | object / null | Optional | |
admission.operation_id | string | Required | Identifier returned by the related operation. minLength: 1; maxLength: 200 |
admission.project_id | string | Required | Project that owns this record. minLength: 1; maxLength: 200 |
admission.context | string | Required | values: "import", "candidate", "candidate_batch", "serve" |
admission.decisions | array | Required | |
admission.decisions[].index | integer | Required | minimum: 0; maximum: 9007199254740991 |
admission.decisions[].url | string | Required | |
admission.decisions[].normalized_url | string / null | Required | |
admission.decisions[].host | string / null | Required | |
admission.decisions[].decision | string | Required | values: "admitted", "rejected" |
admission.decisions[].reason | string | Required | Recorded explanation; null when no explanation applies. |
admission.decisions[].rule_kind | string / null | Required | |
admission.decisions[].rule_id | string / null | Required | Identifier returned by the related operation. |
admission.decisions[].rule_value | string / null | Required | |
admission.decisions[].cap | object / null | Required | |
admission.decisions[].cap.limit | integer | Required | maximum: 9007199254740991; exclusiveMinimum: 0 |
admission.decisions[].cap.used | integer | Required | minimum: 0; maximum: 9007199254740991 |
admission.decisions[].subject_key | string | Required | minLength: 1; maxLength: 200 |
admission.summary | object | Required | additional fields rejected |
admission.summary.total | integer | Required | minimum: -9007199254740991; maximum: 9007199254740991 |
admission.summary.admitted | integer | Required | minimum: -9007199254740991; maximum: 9007199254740991 |
admission.summary.rejected | integer | Required | minimum: -9007199254740991; maximum: 9007199254740991 |
admission.summary.by_rule | object | Required | |
admission.policy_revision | integer | Required | minimum: 0; maximum: 9007199254740991 |
admission.disavow_revision | integer | Required | minimum: 0; maximum: 9007199254740991 |
admission.replayed | boolean | Required | True when the response reuses an earlier request with the same idempotency value. |
rejected | array | Required | |
rejected[].row | number | Required | |
rejected[].reason | string | Required | Recorded explanation; null when no explanation applies. |
rejected[].admission | object | Optional | additional fields rejected |
rejected[].admission.index | integer | Required | minimum: 0; maximum: 9007199254740991 |
rejected[].admission.url | string | Required | |
rejected[].admission.normalized_url | string / null | Required | |
rejected[].admission.host | string / null | Required | |
rejected[].admission.decision | string | Required | values: "admitted", "rejected" |
rejected[].admission.reason | string | Required | Recorded explanation; null when no explanation applies. |
rejected[].admission.rule_kind | string / null | Required | |
rejected[].admission.rule_id | string / null | Required | Identifier returned by the related operation. |
rejected[].admission.rule_value | string / null | Required | |
rejected[].admission.cap | object / null | Required | |
rejected[].admission.cap.limit | integer | Required | maximum: 9007199254740991; exclusiveMinimum: 0 |
rejected[].admission.cap.used | integer | Required | minimum: 0; maximum: 9007199254740991 |
rejected[].admission.subject_key | string | Required | |
duplicates | array | Required | |
duplicates[].row | number | Required | |
duplicates[].first_seen_on_row | number | Required | |
rejected_total | number | Required | |
duplicates_total | number | Required | |