Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Domain Pages Summary

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клиентские библиотеки
Shell Curl

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Операции

Domain Pages Summary

​

Per-page backlink metrics for one target: one row per url with rank, backlinks, first_seen, lost_date, backlinks_spam_score, broken_backlinks and broken_pages. The page-level twin of post_dataforseo_backlinks_summary_live, which reports the same metrics for the domain as a whole. For crawl metadata about those pages instead, use post_dataforseo_backlinks_domain_pages_live.

Тело
обязательно
application/json
  • Тип: array object[]
    • target
      Тип: string
      обязательно

      domain, subdomain or webpage to get summary data for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://)

    • backlinks_filters
      Тип: array

      filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all fields available in the response of this endpoint using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for example: "backlinks_filters": [["dofollow", "=", true]]

    • backlinks_status_type
      Тип: string

      set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target; possible values: all – all backlinks will be returned and counted; live – backlinks found during the last check will be returned and counted; lost – lost backlinks will be returned and counted; default value: live

    • exclude_internal_backlinks
      Тип: boolean

      indicates whether the backlinks from subdomains of the target are excluded optional field if set to false, backlinks from the subdomains of the target domain will be ommited and you won’t receive the same domain in the response; default value: true

    • filters
      Тип: array

      array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, , in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["referring_links_types.anchors",">","1"] [["broken_pages",">","2"], "and", ["backlinks",">","10"]] [["first_seen",">","2017-10-23 11:31:45 +00:00"], "and", [["anchor","like","%seo%"],"or",["referring_domains",">","10"]]] The full list of possible filters is available here.

    • include_indirect_links
      Тип: boolean

      indicates if indirect links to the target will be included in the results optional field if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page if set to false, indirect links will be ignored default value: true

    • include_subdomains
      Тип: boolean

      indicates if the subdomains of the target domain will be included in the search optional field if set to false, the subdomains will be ignored default value: true

    • internal_list_limit
      Тип: integer

      maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: referring_links_tld referring_links_types referring_links_attributes referring_links_platform_types referring_links_semantic_locations default value: 10 maximum value: 1000

    • limit
      Тип: integer

      the maximum number of returned anchors optional field default value: 100 maximum value: 1000

    • offset
      Тип: integer

      offset in the results array of returned anchors optional field default value: 0 if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors

    • order_by
      Тип: array string[]

      results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting type example: ["backlinks,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["backlinks,desc","rank,asc"]

    • rank_scale
      Тип: string

      defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed on a 0–100 scale one_thousand — rank values are displayed on a 0–1000 scale default value: one_thousand learn more about how this parameter works and how ranking metrics are calculated in this Help Center article

    • tag
      Тип: string

      user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

Ответы
  • 200
    Тип: object

    Successful response

    • cost
      Тип: number

      total tasks cost, USD

    • status_code
      Тип: integer

      general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions

    • status_message
      Тип: string

      general informational message you can find the full list of general informational messages here

    • tasks
      Тип: array string[]

      array of tasks

    • tasks_count
      Тип: integer

      the number of tasks in the tasks array

    • tasks_error
      Тип: integer

      the number of tasks in the tasks array returned with an error

    • tasks.cost
      Тип: number

      cost of the task, USD

    • tasks.data
      Тип: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      Тип: string

      task identifier unique task identifier in our system in the UUID format

    • tasks.path
      Тип: array string[]

      URL path

    • tasks.result
      Тип: array string[]

      array of results

    • tasks.result_count
      Тип: integer

      number of elements in the result array

    • tasks.result.items
      Тип: array string[]

      items array

    • tasks.result.items_count
      Тип: integer

      number of items in the results array

    • Тип: integer

      number of backlinks

    • Тип: integer

      average spam score of the backlinks pointing to the page learn more about how the metric is calculated on this help center page

    • Тип: integer

      number of broken backlinks number of broken backlinks pointing to the page

    • tasks.result.items.broken_pages
      Тип: integer

      number of broken pages number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to

    • tasks.result.items.first_seen
      Тип: string

      date and time when our crawler found a backlink to this page for the first time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

    • tasks.result.items.lost_date
      Тип: string

      date and time when the last backlink to this page was lost indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2017-01-24 13:20:59 +00:00

    • tasks.result.items.rank
      Тип: integer

      page rank rank of the page rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article

    • tasks.result.items.referring_domains
      Тип: integer

      indicates the number domains referring to the page

    • tasks.result.items.referring_domains_nofollow
      Тип: integer

      number of domains pointing at least one nofollow link to the page

    • tasks.result.items.referring_ips
      Тип: integer

      number of referring IP addresses number of IP addresses pointing to this page

    • Тип: object

      link attributes of the referring links indicates link attributes of the referring links and link count per each attribute

    • Тип: object

      ISO country codes of the referring links indicates ISO country codes of the domains where the referring links are located and the link count per each country

    • Тип: object

      types of referring platforms indicates referring platform types and and link count per each platform possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization

    • Тип: object

      semantic locations of the referring links indicates semantic elements in HTML where the referring links are located and link count per each semantic location you can get the full list of semantic elements here examples: article, section, footer

    • Тип: object

      top-level domains of the referring links contains top level domains and referring link count per each

    • Тип: object

      types of referring links indicates the types of the referring links and link count per each type possible values: anchor, image, link, meta, canonical, alternate, redirect

    • tasks.result.items.referring_main_domains
      Тип: integer

      indicates the number of referring main domains

    • tasks.result.items.referring_main_domains_nofollow
      Тип: integer

      number of main domains pointing at least one nofollow link to the page

    • tasks.result.items.referring_pages
      Тип: integer

      indicates the number of pages pointing to the relevant url

    • tasks.result.items.referring_pages_nofollow
      Тип: integer

      number of referring pages pointing at least one nofollow link to the page

    • tasks.result.items.referring_subnets
      Тип: integer

      number of referring subnetworks

    • tasks.result.items.type
      Тип: string

      type of element = ‘backlinks_page_summary’

    • tasks.result.items.url
      Тип: string

      page URL

    • tasks.result.target
      Тип: string

      target in the post array

    • tasks.result.total_count
      Тип: integer

      total number of relevant items in the database

    • tasks.status_code
      Тип: integer

      status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here

    • tasks.status_message
      Тип: string

      informational message of the task you can find the full list of general informational messages here

    • tasks.time
      Тип: string

      execution time, seconds

    • time
      Тип: string

      execution time, seconds

    • version
      Тип: string

      the current version of the API

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/backlinks/domain_pages_summary/live
curl https://openapi.felo.ai/v1/beta/dataforseo/backlinks/domain_pages_summary/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "",
    "limit": 1,
    "offset": 1,
    "internal_list_limit": 1,
    "backlinks_status_type": "",
    "filters": [],
    "order_by": [
      ""
    ],
    "backlinks_filters": [],
    "include_subdomains": true,
    "include_indirect_links": true,
    "exclude_internal_backlinks": true,
    "rank_scale": "",
    "tag": ""
  }
]'

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.target": "string",
  "tasks.result.total_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.type": "string",
  "tasks.result.items.url": "string",
  "tasks.result.items.rank": 1,
  "tasks.result.items.backlinks": 1,
  "tasks.result.items.first_seen": "string",
  "tasks.result.items.lost_date": "string",
  "tasks.result.items.backlinks_spam_score": 1,
  "tasks.result.items.broken_backlinks": 1,
  "tasks.result.items.broken_pages": 1,
  "tasks.result.items.referring_domains": 1,
  "tasks.result.items.referring_domains_nofollow": 1,
  "tasks.result.items.referring_main_domains": 1,
  "tasks.result.items.referring_main_domains_nofollow": 1,
  "tasks.result.items.referring_ips": 1,
  "tasks.result.items.referring_subnets": 1,
  "tasks.result.items.referring_pages": 1,
  "tasks.result.items.referring_links_tld": {},
  "tasks.result.items.referring_links_types": {},
  "tasks.result.items.referring_links_attributes": {},
  "tasks.result.items.referring_links_platform_types": {},
  "tasks.result.items.referring_links_semantic_locations": {},
  "tasks.result.items.referring_links_countries": {},
  "tasks.result.items.referring_pages_nofollow": 1
}

Successful response

Domain Pages Summary