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

Backlinks Timeseries Summary

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

DataForSEO

​

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

DataForSEO Операции

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.

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

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

    • date_from
      Тип: string

      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_to
      Тип: string

      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_range
      Тип: string

      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_subdomains
      Тип: boolean

      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_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.date_from
      Тип: string

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

    • tasks.result.date_to
      Тип: string

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

    • tasks.result.group_range
      Тип: object

      group_range from a POST array

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

      contains relevant summary data

    • tasks.result.items_count
      Тип: integer

      the number of results returned in the items array

    • Тип: integer

      number of backlinks for the given date

    • Тип: integer

      number of nofollow backlinks for the given date

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

      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

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

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

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

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

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

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

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

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

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

      number of referring main domains for the given date

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

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

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

      number of pages pointing to target for the given date

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

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

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

      number of referring subnetworks for the given date

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

      type of element = ‘backlinks_timeseries_summary’

    • tasks.result.target
      Тип: string

      target from a POST array

    • tasks.result.total_count
      Тип: integer

      total amount of results relevant the request

    • 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/timeseries_summary/live
curl https://openapi.felo.ai/v1/beta/dataforseo/backlinks/timeseries_summary/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "",
    "date_from": "",
    "date_to": "",
    "group_range": "",
    "include_subdomains": 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.date_from": "string",
  "tasks.result.date_to": "string",
  "tasks.result.group_range": {},
  "tasks.result.total_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.type": "string",
  "tasks.result.items.date": "string",
  "tasks.result.items.rank": 1,
  "tasks.result.items.backlinks": 1,
  "tasks.result.items.backlinks_nofollow": 1,
  "tasks.result.items.referring_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_nofollow": 1
}

Successful response

Backlinks Timeseries Summary