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

New & Lost Backlinks Timeseries Summary

サーバー:https://openapi.felo.ai
クライアントライブラリ

DataForSEO

​

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

New & Lost Backlinks Timeseries Summary

​

New and lost backlinks and referring domains for one target per period, grouped by group_range. This is the derivative of post_dataforseo_backlinks_timeseries_summary_live: that one gives the level, this one the change. A flat total hiding heavy churn only shows up here. For the same figures across many targets at once use post_dataforseo_backlinks_bulk_new_lost_backlinks_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 new and lost backlinks and referring domains; the backlinks and referring domains that appeared in our index after the specified date will be considered as new; the backlinks and referring domains that weren’t found after the specified date, but were present before, will be considered as lost; 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

    • 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
      型: string

      group_range from the POST array

    • tasks.result.items
      型: array string[]

      contains relevant backlinks and referring domains data

    • tasks.result.items_count
      型: integer

      the number of results returned in the items array

    • 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

    • 型: integer

      number of lost backlinks number of lost backlinks of the target

    • tasks.result.items.lost_referring_domains
      型: integer

      number of lost referring domains number of lost referring domains of the target

    • tasks.result.items.lost_referring_main_domains
      型: integer

      number of lost referring main domains number of lost referring main domains of the target

    • 型: integer

      number of new backlinks number of new backlinks pointing to the target

    • tasks.result.items.new_referring_domains
      型: integer

      number of new referring domains number of new referring domains pointing to the target

    • tasks.result.items.new_referring_main_domains
      型: integer

      number of new referring main domains number of new referring main domains pointing to the target

    • tasks.result.items.type
      型: string

      type of element = ‘backlinks_timeseries_new_lost_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_new_lost_summary/live
curl https://openapi.felo.ai/v1/beta/dataforseo/backlinks/timeseries_new_lost_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,
    "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": "string",
  "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.new_backlinks": 1,
  "tasks.result.items.lost_backlinks": 1,
  "tasks.result.items.new_referring_domains": 1,
  "tasks.result.items.lost_referring_domains": 1,
  "tasks.result.items.new_referring_main_domains": 1,
  "tasks.result.items.lost_referring_main_domains": 1
}
New & Lost Backlinks Timeseries Summary