Sign in
Backlinks

Changed on

‌ This endpoint will provide you with an overview of backlink data for the target domain available during a period between the two indicated dates. Backlink metrics will be grouped by the time range that you define: day, week, month, or year.

post/v3/backlinks/timeseries_summary/live

Request

  • Base URL: https://api.dataforseo.com
  • URL: https://api.dataforseo.com/v3/backlinks/timeseries_summary/live
  • Auth: HTTP basic

Request body

targetstring

<em>domain to get data for</em><br><strong>required field</strong><br>a domain should be specified without <code>https://</code> and <code>www.</code><br>example:<br><code>"forbes.com"</code>

date_fromstring nullable

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

date_tostring nullable

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

group_rangestring nullable

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

include_subdomainsboolean nullable

<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>

rank_scalestring nullable

<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>

tagstring nullable

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

Example request

[
  {
    "target": "dataforseo.com",
    "date_from": "2021-12-01",
    "date_to": "2022-02-01",
    "group_range": "month"
  }
]

Response

Successful operation

versionstring nullable

the current version of the API

status_codeinteger nullable

general status code you can find the full list of the response codes here

status_messagestring nullable

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

timestring nullable

total execution time, seconds

costnumber double nullable

total tasks cost, USD

tasks_countinteger nullable

the number of tasks in the tasks array

tasks_errorinteger nullable

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

Changes