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

Historical Rank Overview

Felo API Support
MIT
伺服器:https://openapi.felo.ai
用戶端程式庫
Shell Curl

DataForSEO

​

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

DataForSEO 操作

Historical Rank Overview

​

A domain's rank overview as it stood at each point in the available history. This one takes no limit parameter, but it is priced per call rather than per item, so send the whole list at once. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Check get_dataforseo_labs_google_available_history first - it names the dates that exist, and asking for a date outside them returns nothing rather than an error. The current snapshot is post_dataforseo_labs_google_domain_rank_overview_live.

請求本文
必填
application/json
  • 類型: array object[]
    • 類型: object
      • target
        類型: string
        必填

        domain required field the domain name of the target website the domain should be specified without https:// and www.

      • correlate
        類型: boolean

        correlate data with previously obtained datasets optional field default value: true if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any inconsistencies that may result from changes to our database we recommend always setting correlate to true

      • date_from
        類型: string

        starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 6 months minimal possible value: 2020-10-01 date format: "yyyy-mm-dd"

      • 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 date format: "yyyy-mm-dd" example: "2021-04-01"

      • ignore_synonyms
        類型: boolean

        ignore highly similar keywords optional field if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; default value: false

      • include_clickstream_data
        類型: boolean

        include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response; default value: false; Note: historical clickstream data is available from 2024/05 (May, 2024); with this parameter enabled, you will be charged double the price for the request; learn more about how clickstream-based metrics are calculated in this help center article

      • language_code
        類型: string

        language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en

      • language_name
        類型: string

        full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English

      • location_code
        類型: integer

        location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840

      • location_name
        類型: string

        full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom

      • 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[]

      contains historical ranking and traffic data

    • tasks.result.items_count
      類型: integer

      the number of results returned in the items array

    • tasks.result.items.metrics
      類型: object

      ranking data relevant to the specified domain

    • tasks.result.items.metrics.organic
      類型: object

      ranking and traffic data from organic search

    • tasks.result.items.metrics.organic.18-24
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 18-24 age range

    • tasks.result.items.metrics.organic.25-34
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 25-34 age range

    • tasks.result.items.metrics.organic.35-44
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 35-44 age range

    • tasks.result.items.metrics.organic.45-54
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 45-54 age range

    • tasks.result.items.metrics.organic.55-64
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 55-64 age range

    • tasks.result.items.metrics.organic.clickstream_age_distribution
      類型: object

      distribution of clickstream-based metrics by age to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.organic.clickstream_etv
      類型: integer

      estimated traffic volume based on clickstream data calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.organic.clickstream_gender_distribution
      類型: object

      distribution of estimated clickstream-based metrics by gender to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.organic.count
      類型: integer

      total count of organic SERPs that contain the domain

    • tasks.result.items.metrics.organic.estimated_paid_traffic_cost
      類型: number

      estimated cost of converting organic search traffic into paid represents the estimated monthly cost of running ads (USD) for all keywords that a domain ranks for the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.organic.etv
      類型: number

      estimated traffic volume estimated organic monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.organic.female
      類型: integer

      number of female users in the relevant clickstream dataset

    • tasks.result.items.metrics.organic.is_down
      類型: integer

      rank went down indicates how many ranked elements of the indicated target went down

    • tasks.result.items.metrics.organic.is_lost
      類型: integer

      lost ranked elements indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check

    • tasks.result.items.metrics.organic.is_new
      類型: integer

      number of new ranked elements indicates how many new ranked elements were found for the indicated target

    • tasks.result.items.metrics.organic.is_up
      類型: integer

      rank went up indicates how many ranked elements of the indicated target went up

    • tasks.result.items.metrics.organic.male
      類型: integer

      number of male users in the relevant clickstream dataset

    • tasks.result.items.metrics.organic.pos_1
      類型: integer

      number of organic SERPs where the domain ranks #1

    • tasks.result.items.metrics.organic.pos_11_20
      類型: integer

      number of organic SERPs where the domain ranks #11-20

    • tasks.result.items.metrics.organic.pos_2_3
      類型: integer

      number of organic SERPs where the domain ranks #2-3

    • tasks.result.items.metrics.organic.pos_21_30
      類型: integer

      number of organic SERPs where the domain ranks #21-30

    • tasks.result.items.metrics.organic.pos_31_40
      類型: integer

      number of organic SERPs where the domain ranks #31-40

    • tasks.result.items.metrics.organic.pos_4_10
      類型: integer

      number of organic SERPs where the domain ranks #4-10

    • tasks.result.items.metrics.organic.pos_41_50
      類型: integer

      number of organic SERPs where the domain ranks #41-50

    • tasks.result.items.metrics.organic.pos_51_60
      類型: integer

      number of organic SERPs where the domain ranks #51-60

    • tasks.result.items.metrics.organic.pos_61_70
      類型: integer

      number of organic SERPs where the domain ranks #61-70

    • tasks.result.items.metrics.organic.pos_71_80
      類型: integer

      number of organic SERPs where the domain ranks #71-80

    • tasks.result.items.metrics.organic.pos_81_90
      類型: integer

      number of organic SERPs where the domain ranks #81-90

    • tasks.result.items.metrics.organic.pos_91_100
      類型: integer

      number of organic SERPs where the domain ranks #91-100

    • tasks.result.items.metrics.paid
      類型: object

      ranking and traffic data from paid search

    • tasks.result.items.metrics.paid.18-24
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 18-24 age range

    • tasks.result.items.metrics.paid.25-34
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 25-34 age range

    • tasks.result.items.metrics.paid.35-44
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 35-44 age range

    • tasks.result.items.metrics.paid.45-54
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 45-54 age range

    • tasks.result.items.metrics.paid.55-64
      類型: integer

      number of users in the relevant clickstream dataset that fall within the 55-64 age range

    • tasks.result.items.metrics.paid.clickstream_age_distribution
      類型: object

      distribution of clickstream-based metrics by age to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.paid.clickstream_etv
      類型: integer

      estimated traffic volume based on clickstream data calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.paid.clickstream_gender_distribution
      類型: object

      distribution of estimated clickstream-based metrics by gender to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.paid.count
      類型: integer

      total count of paid SERPs that contain the domain

    • tasks.result.items.metrics.paid.estimated_paid_traffic_cost
      類型: number

      estimated cost of monthly search traffic represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.paid.etv
      類型: number

      estimated traffic volume estimated paid monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article

    • tasks.result.items.metrics.paid.female
      類型: integer

      number of female users in the relevant clickstream dataset

    • tasks.result.items.metrics.paid.is_down
      類型: integer

      rank went down indicates how many ranked elements of the indicated target went down

    • tasks.result.items.metrics.paid.is_lost
      類型: integer

      lost ranked elements indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check

    • tasks.result.items.metrics.paid.is_new
      類型: integer

      number of new ranked elements indicates how many new ranked elements were found for the indicated target

    • tasks.result.items.metrics.paid.is_up
      類型: integer

      rank went up indicates how many ranked elements of the indicated target went up

    • tasks.result.items.metrics.paid.male
      類型: integer

      number of male users in the relevant clickstream dataset

    • tasks.result.items.metrics.paid.pos_1
      類型: integer

      number of paid SERPs where the domain ranks #1

    • tasks.result.items.metrics.paid.pos_11_20
      類型: integer

      number of paid SERPs where the domain ranks #11-20

    • tasks.result.items.metrics.paid.pos_2_3
      類型: integer

      number of paid SERPs where the domain ranks #2-3

    • tasks.result.items.metrics.paid.pos_21_30
      類型: integer

      number of paid SERPs where the domain ranks #21-30

    • tasks.result.items.metrics.paid.pos_31_40
      類型: integer

      number of paid SERPs where the domain ranks #31-40

    • tasks.result.items.metrics.paid.pos_4_10
      類型: integer

      number of paid SERPs where the domain ranks #4-10

    • tasks.result.items.metrics.paid.pos_41_50
      類型: integer

      number of paid SERPs where the domain ranks #41-50

    • tasks.result.items.metrics.paid.pos_51_60
      類型: integer

      number of paid SERPs where the domain ranks #51-60

    • tasks.result.items.metrics.paid.pos_61_70
      類型: integer

      number of paid SERPs where the domain ranks #61-70

    • tasks.result.items.metrics.paid.pos_71_80
      類型: integer

      number of paid SERPs where the domain ranks #71-80

    • tasks.result.items.metrics.paid.pos_81_90
      類型: integer

      number of paid SERPs where the domain ranks #81-90

    • tasks.result.items.metrics.paid.pos_91_100
      類型: integer

      number of paid SERPs where the domain ranks #91-100

    • tasks.result.items.month
      類型: integer

      month for which the data is provided

    • tasks.result.items.se_type
      類型: string

      search engine type

    • tasks.result.items.year
      類型: integer

      year for which the data is provided

    • tasks.result.language_code
      類型: string

      language code in a POST array

    • tasks.result.location_code
      類型: integer

      location code in a POST array

    • tasks.result.se_type
      類型: string

      search engine type

    • tasks.result.target
      類型: string

      target domain in a POST array

    • tasks.result.total_count
      類型: integer

      total amount of results in our database relevant to your 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/dataforseo_labs/google/historical_rank_overview/live
curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/historical_rank_overview/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {},
  {}
]'

{
  "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.se_type": "string",
  "tasks.result.target": "string",
  "tasks.result.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.total_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.se_type": "string",
  "tasks.result.items.year": 1,
  "tasks.result.items.month": 1,
  "tasks.result.items.metrics": {},
  "tasks.result.items.metrics.organic": {},
  "tasks.result.items.metrics.organic.pos_1": 1,
  "tasks.result.items.metrics.organic.pos_2_3": 1,
  "tasks.result.items.metrics.organic.pos_4_10": 1,
  "tasks.result.items.metrics.organic.pos_11_20": 1,
  "tasks.result.items.metrics.organic.pos_21_30": 1,
  "tasks.result.items.metrics.organic.pos_31_40": 1,
  "tasks.result.items.metrics.organic.pos_41_50": 1,
  "tasks.result.items.metrics.organic.pos_51_60": 1,
  "tasks.result.items.metrics.organic.pos_61_70": 1,
  "tasks.result.items.metrics.organic.pos_71_80": 1,
  "tasks.result.items.metrics.organic.pos_81_90": 1,
  "tasks.result.items.metrics.organic.pos_91_100": 1,
  "tasks.result.items.metrics.organic.etv": 1,
  "tasks.result.items.metrics.organic.count": 1,
  "tasks.result.items.metrics.organic.estimated_paid_traffic_cost": 1,
  "tasks.result.items.metrics.organic.is_new": 1,
  "tasks.result.items.metrics.organic.is_up": 1,
  "tasks.result.items.metrics.organic.is_down": 1,
  "tasks.result.items.metrics.organic.is_lost": 1,
  "tasks.result.items.metrics.organic.clickstream_etv": 1,
  "tasks.result.items.metrics.organic.clickstream_gender_distribution": {},
  "tasks.result.items.metrics.organic.female": 1,
  "tasks.result.items.metrics.organic.male": 1,
  "tasks.result.items.metrics.organic.clickstream_age_distribution": {},
  "tasks.result.items.metrics.organic.18-24": 1,
  "tasks.result.items.metrics.organic.25-34": 1,
  "tasks.result.items.metrics.organic.35-44": 1,
  "tasks.result.items.metrics.organic.45-54": 1,
  "tasks.result.items.metrics.organic.55-64": 1,
  "tasks.result.items.metrics.paid": {},
  "tasks.result.items.metrics.paid.pos_1": 1,
  "tasks.result.items.metrics.paid.pos_2_3": 1,
  "tasks.result.items.metrics.paid.pos_4_10": 1,
  "tasks.result.items.metrics.paid.pos_11_20": 1,
  "tasks.result.items.metrics.paid.pos_21_30": 1,
  "tasks.result.items.metrics.paid.pos_31_40": 1,
  "tasks.result.items.metrics.paid.pos_41_50": 1,
  "tasks.result.items.metrics.paid.pos_51_60": 1,
  "tasks.result.items.metrics.paid.pos_61_70": 1,
  "tasks.result.items.metrics.paid.pos_71_80": 1,
  "tasks.result.items.metrics.paid.pos_81_90": 1,
  "tasks.result.items.metrics.paid.pos_91_100": 1,
  "tasks.result.items.metrics.paid.etv": 1,
  "tasks.result.items.metrics.paid.count": 1,
  "tasks.result.items.metrics.paid.estimated_paid_traffic_cost": 1,
  "tasks.result.items.metrics.paid.is_new": 1,
  "tasks.result.items.metrics.paid.is_up": 1,
  "tasks.result.items.metrics.paid.is_down": 1,
  "tasks.result.items.metrics.paid.is_lost": 1,
  "tasks.result.items.metrics.paid.clickstream_etv": 1,
  "tasks.result.items.metrics.paid.clickstream_gender_distribution": {},
  "tasks.result.items.metrics.paid.female": 1,
  "tasks.result.items.metrics.paid.male": 1,
  "tasks.result.items.metrics.paid.clickstream_age_distribution": {},
  "tasks.result.items.metrics.paid.18-24": 1,
  "tasks.result.items.metrics.paid.25-34": 1,
  "tasks.result.items.metrics.paid.35-44": 1,
  "tasks.result.items.metrics.paid.45-54": 1,
  "tasks.result.items.metrics.paid.55-64": 1
}

Successful response

Historical Rank Overview