total | integer / null | Optional | |
has_more | boolean | Optional | True when another page is available. |
next_cursor | string / null | Required | Opaque continuation for the same listing; null means no further page. |
page | object | Optional | additional fields rejected |
page.limit | integer | Required | maximum: 9007199254740991; exclusiveMinimum: 0 |
page.sort | string | Required | |
page.order | string | Required | values: "asc", "desc" |
page.total | integer / null | Required | |
page.query_scope | string | Required | must equal "server_dataset" |
page.nulls | string | Required | must equal "last" |
items | array | Required | Records in this bounded page. |
items[].v | number | Required | must equal 1 |
items[].id | string | Required | Resource identifier returned by the operation. minLength: 1; maxLength: 128; pattern: "^[a-zA-Z0-9_-]+$" |
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[].provider | string | Required | values: "linktrail_corpus", "dataforseo", "imported" |
items[].data_mode | string | Required | values: "synthetic", "owned_corpus", "provider_index", "imported" |
items[].query | object | Required | additional fields rejected |
items[].query.target_kind | string | Required | values: "domain", "exact_url" |
items[].query.target | string | Required | minLength: 1; maxLength: 4096 |
items[].query.include_subdomains | boolean | Required | |
items[].query.backlinks_status_type | string | Required | values: "live", "lost", "all" |
items[].query.exclude_internal_backlinks | boolean | Required | |
items[].query.mode | string | Required | must equal "as_is" |
items[].query.filters | null | Required | |
items[].query.order_by | array | Required | minItems: 1; maxItems: 1 |
items[].query.rank_scale | string / null | Required | |
items[].query.page_limit | integer | Required | minimum: 1; maximum: 1000 |
items[].query.row_limit | integer | Required | minimum: 1; maximum: 1000 |
items[].status | string | Required | Resource lifecycle status. values: "queued", "running", "succeeded", "partial", "failed", "reconciliation_required" |
items[].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))$" |
items[].started_at | string / null | Required | |
items[].finished_at | string / null | Required | |
items[].coverage | string | Required | Dataset scope and completeness, including limits on what these results establish. values: "pending", "complete_for_query", "capped", "partial", "unknown" |
items[].coverage_reason | string / null | Required | |
items[].provider_total_count | integer / null | Required | |
items[].usage | object | Required | additional fields rejected |
items[].usage.unit | string | Required | must equal "discovery" |
items[].usage.currency | string | Required | must equal "USD" |
items[].usage.quote_id | string | Required | Identifier returned by the related operation. minLength: 1; maxLength: 128; pattern: "^[a-zA-Z0-9_-]+$" |
items[].usage.max_cost_microusd | integer | Required | minimum: 0; maximum: 9007199254740991 |
items[].usage.reserved_cost_microusd | integer | Required | minimum: 0; maximum: 9007199254740991 |
items[].usage.provider_reported_cost_microusd | integer / null | Required | |
items[].usage.request_count | integer | Required | minimum: 0; maximum: 9007199254740991 |
items[].usage.returned_rows | integer | Required | minimum: 0; maximum: 9007199254740991 |
items[].usage.accepted_candidates | integer | Required | minimum: 0; maximum: 9007199254740991 |
items[].usage.rejected_rows | integer | Required | minimum: 0; maximum: 9007199254740991 |
items[].usage.duplicate_rows | integer | Required | minimum: 0; maximum: 9007199254740991 |
items[].operation | string | Required | must equal "backlinks" |
items[].coverage_scope | string | Required | values: "customer_import", "corpus_subset", "provider_query" |
items[].whole_web_coverage | boolean | Required | False: these results do not measure the whole web. must equal false |
items[].replayed | boolean | Optional | True when the response reuses an earlier request with the same idempotency value. |