Felo API PlatformFelo API Platform

Data API / DataForSEO / Backlinks

Backlinks Timeseries Summary

One target's core backlink metrics over time, grouped by group_range (day, week, month). Returns date_from, date_to, group_range and one item per period. For gains and losses rather than totals use post_dataforseo_backlinks_timeseries_new_lost_live. This one takes no limit parameter, so the only lever is calling it less often.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

  • targetstringОбязательный

    domain to get data for required field a domain should be specified without https:// and www. example: "forbes.com"

  • date_fromstringНеобязательный

    starting date of the time range optional field this field indicates the date which will be used as a threshold for summary data; minimum value: 2019-01-30 maximum value shouldn’t exceed the date specified in the date_to date format: "yyyy-mm-dd" example: "2021-01-01"

  • date_tostringНеобязательный

    ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default minimum value shouldn’t preceed the date specified in the date_from maximum value: today’s date date format: "yyyy-mm-dd" example: "2021-01-15"

  • group_rangestringНеобязательный

    time range which will be used to group the results optional field default value: month possible values: day, week, month, year note: for day, we will return items corresponding to all dates between and including date_from and date_to; for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year for example, if you specify: "group_range": "month", "date_from": "2022-03-23", "date_to": "2022-05-13" we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31 if there is no data for a certain day/week/month/year, we will return 0

  • include_subdomainsbooleanНеобязательный

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

  • rank_scalestringНеобязательный

    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

  • tagstringНеобязательный

    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

Пример запроса

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/backlinks/timeseries_summary/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "<string>",
  "date_from": "<string>",
  "date_to": "<string>",
  "group_range": "<string>",
  "include_subdomains": false,
  "rank_scale": "<string>",
  "tag": "<string>"
}'

Ответ

Поля ответа

  • versionstringНеобязательный

    the current version of the API

  • status_codeintegerНеобязательный

    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_messagestringНеобязательный

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

  • timestringНеобязательный

    execution time, seconds

  • costnumberНеобязательный

    total tasks cost, USD

  • tasks_countintegerНеобязательный

    the number of tasks in the tasks array

  • tasks_errorintegerНеобязательный

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

  • tasksstring[]Необязательный

    array of tasks

  • idstringНеобязательный

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

  • status_codeintegerНеобязательный

    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

  • status_messagestringНеобязательный

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

  • timestringНеобязательный

    execution time, seconds

  • costnumberНеобязательный

    cost of the task, USD

  • result_countintegerНеобязательный

    number of elements in the result array

  • pathstring[]Необязательный

    URL path

  • dataobjectНеобязательный

    contains the same parameters that you specified in the POST request

  • resultstring[]Необязательный

    array of results

  • targetstringНеобязательный

    target from a POST array

  • date_fromstringНеобязательный

    starting date of the time range in the UTC format: “yyyy-mm-dd” example: 2019-01-01

  • date_tostringНеобязательный

    ending date of the time range in the UTC format: "yyyy-mm-dd" example: "2019-01-15"

  • group_rangeobjectНеобязательный

    group_range from a POST array

  • total_countintegerНеобязательный

    total amount of results relevant the request

  • items_countintegerНеобязательный

    the number of results returned in the items array

  • itemsstring[]Необязательный

    contains relevant summary data

  • typestringНеобязательный

    type of element = ‘backlinks_timeseries_summary’

  • datestringНеобязательный

    date and time when the data for the target was stored in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

  • rankintegerНеобязательный

    target rank for the given date learn more about the metric and how it is calculated in this help center article

  • backlinksintegerНеобязательный

    number of backlinks for the given date

  • backlinks_nofollowintegerНеобязательный

    number of nofollow backlinks for the given date

  • referring_pagesintegerНеобязательный

    number of pages pointing to target for the given date

  • referring_domainsintegerНеобязательный

    number of referring domains for the given date referring domains include subdomains that are counted as separate domains for this metric

  • referring_domains_nofollowintegerНеобязательный

    number of domains pointing at least one nofollow link to the target for the given date

  • referring_main_domainsintegerНеобязательный

    number of referring main domains for the given date

  • referring_main_domains_nofollowintegerНеобязательный

    number of main domains pointing at least one nofollow link to the target for the given date

  • referring_ipsintegerНеобязательный

    number of referring IP addresses for the given date number of IP addresses pointing to this page

  • referring_subnetsintegerНеобязательный

    number of referring subnetworks for the given date

  • referring_pages_nofollowintegerНеобязательный

    number of referring pages pointing at least one nofollow link to the target for the given date