Felo API PlatformFelo API Platform

데이터 API / DataForSEO / DataForSEO Labs

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.

파라미터

경로, 쿼리, 헤더 파라미터가 없습니다.

요청 본문

  • targetstring필수

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

  • location_namestring선택

    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

  • location_codeinteger선택

    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

  • language_namestring선택

    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

  • language_codestring선택

    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

  • date_fromstring선택

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

  • correlateboolean선택

    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

  • ignore_synonymsboolean선택

    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_databoolean선택

    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

  • 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/dataforseo_labs/google/historical_rank_overview/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "date_from": "<string>",
  "date_to": "<string>",
  "correlate": false
}'

응답

응답 필드

  • 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

  • se_typestring선택

    search engine type

  • targetstring선택

    target domain in a POST array

  • location_codeinteger선택

    location code in a POST array

  • language_codestring선택

    language code in a POST array

  • total_countinteger선택

    total amount of results in our database relevant to your request

  • items_countinteger선택

    the number of results returned in the items array

  • itemsstring[]선택

    contains historical ranking and traffic data

  • se_typestring선택

    search engine type

  • yearinteger선택

    year for which the data is provided

  • monthinteger선택

    month for which the data is provided

  • metricsobject선택

    ranking data relevant to the specified domain

  • organicobject선택

    ranking and traffic data from organic search

  • pos_1integer선택

    number of organic SERPs where the domain ranks #1

  • pos_2_3integer선택

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

  • pos_4_10integer선택

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

  • pos_11_20integer선택

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

  • pos_21_30integer선택

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

  • pos_31_40integer선택

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

  • pos_41_50integer선택

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

  • pos_51_60integer선택

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

  • pos_61_70integer선택

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

  • pos_71_80integer선택

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

  • pos_81_90integer선택

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

  • pos_91_100integer선택

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

  • etvnumber선택

    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

  • countinteger선택

    total count of organic SERPs that contain the domain

  • estimated_paid_traffic_costnumber선택

    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

  • is_newinteger선택

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

  • is_upinteger선택

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

  • is_downinteger선택

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

  • is_lostinteger선택

    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

  • clickstream_etvinteger선택

    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

  • clickstream_gender_distributionobject선택

    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

  • femaleinteger선택

    number of female users in the relevant clickstream dataset

  • maleinteger선택

    number of male users in the relevant clickstream dataset

  • clickstream_age_distributionobject선택

    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

  • 18-24integer선택

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

  • 25-34integer선택

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

  • 35-44integer선택

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

  • 45-54integer선택

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

  • 55-64integer선택

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

  • paidobject선택

    ranking and traffic data from paid search

  • pos_1integer선택

    number of paid SERPs where the domain ranks #1

  • pos_2_3integer선택

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

  • pos_4_10integer선택

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

  • pos_11_20integer선택

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

  • pos_21_30integer선택

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

  • pos_31_40integer선택

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

  • pos_41_50integer선택

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

  • pos_51_60integer선택

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

  • pos_61_70integer선택

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

  • pos_71_80integer선택

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

  • pos_81_90integer선택

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

  • pos_91_100integer선택

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

  • etvnumber선택

    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

  • countinteger선택

    total count of paid SERPs that contain the domain

  • estimated_paid_traffic_costnumber선택

    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

  • is_newinteger선택

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

  • is_upinteger선택

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

  • is_downinteger선택

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

  • is_lostinteger선택

    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

  • clickstream_etvinteger선택

    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

  • clickstream_gender_distributionobject선택

    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

  • femaleinteger선택

    number of female users in the relevant clickstream dataset

  • maleinteger선택

    number of male users in the relevant clickstream dataset

  • clickstream_age_distributionobject선택

    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

  • 18-24integer선택

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

  • 25-34integer선택

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

  • 35-44integer선택

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

  • 45-54integer선택

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

  • 55-64integer선택

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