Felo API PlatformFelo API Platform

데이터 API / DataForSEO / DataForSEO Labs

Relevant Pages

Which pages of a target site earn its rankings, ranked by the traffic they bring. Pages with limit, offset and offset_token; use the token past the first pages. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Use it to find the pages worth defending or expanding. For the keywords behind them use post_dataforseo_labs_google_kw_for_site_live; for the pages earning links rather than rankings, post_dataforseo_backlinks_domain_pages_summary_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 optional field if you use this field, you don’t need to specify 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 ignore this field to get the results for all available locations example: United Kingdom

  • location_codeinteger선택

    location code optional field if you use this field, you don’t need to specify location_name 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 ignore this field to get the results for all available locations example: 2840

  • language_namestring선택

    full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English

  • language_codestring선택

    language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en

  • item_typesstring[]선택

    display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ["organic", "paid", "featured_snippet", "local_pack"] default value: ["organic", "paid"]

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

  • limitinteger선택

    the maximum number of returned pages optional field default value: 100 maximum value: 1000

  • offsetinteger선택

    offset in the results array of returned pages optional field default value: 0 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages

  • historical_serp_modestring선택

    data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live

  • ignore_synonymsboolean선택

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

  • filtersarray선택

    array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , , >, >=, =, , in, not_in example: ["metrics.paid.count",">",0] [["metrics.organic.count",">",50],"and",["metrics.organic.pos_1","",0]] [[""metrics.organic.count",">",50"], "and", [["metrics.organic.pos_1","",0],"or",["metrics.organic.pos_2_3","",0]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide

  • order_bystring[]선택

    results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to specify a sorting type example: ["metrics.paid.etv,asc"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["metrics.organic.etv,desc","metrics.paid.count,asc"] default rule: ["metrics.organic.count,desc"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array

  • 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/relevant_pages/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>",
  "item_types": [
    "<string>"
  ],
  "include_clickstream_data": false,
  "limit": 0
}'

응답

응답 필드

  • 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 if there is no data, then the value is null

  • language_codestring선택

    language code in a POST array if there is no data, then the value is null

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

    relevant pages and related data

  • page_addressstring선택

    absolute URL of the relevant page

  • metricsobject선택

    rankings and traffic metrics for the relevant page

  • organicobject선택

    ranking and traffic data from organic search

  • pos_1integer선택

    number of organic SERPs where the page ranks #1

  • pos_2_3integer선택

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

  • pos_4_10integer선택

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

  • pos_11_20integer선택

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

  • pos_21_30integer선택

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

  • pos_31_40integer선택

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

  • pos_41_50integer선택

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

  • pos_51_60integer선택

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

  • pos_61_70integer선택

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

  • pos_71_80integer선택

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

  • pos_81_90integer선택

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

  • pos_91_100integer선택

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

  • etvnumber선택

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

  • countinteger선택

    total count of organic SERPs that contain the page

  • estimated_paid_traffic_costnumber선택

    estimated cost of converting organic search traffic into paid represents the estimated monthly cost (USD) of running ads for all keywords in the category that a page 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 page

  • is_upinteger선택

    rank went up indicates how many ranked elements of the page went up

  • is_downinteger선택

    rank went down indicates how many ranked elements of the page went down

  • is_lostinteger선택

    lost ranked elements indicates how many ranked elements of the page 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 page ranks #1

  • pos_2_3integer선택

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

  • pos_4_10integer선택

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

  • pos_11_20integer선택

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

  • pos_21_30integer선택

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

  • pos_31_40integer선택

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

  • pos_41_50integer선택

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

  • pos_51_60integer선택

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

  • pos_61_70integer선택

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

  • pos_71_80integer선택

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

  • pos_81_90integer선택

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

  • pos_91_100integer선택

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

  • etvnumber선택

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

  • countinteger선택

    total count of paid SERPs that contain the page

  • 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 of all keywords in the category that the page ranks for 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 page

  • is_upinteger선택

    rank went up indicates how many ranked elements of the page went up

  • is_downinteger선택

    rank went down indicates how many ranked elements of the page went down

  • is_lostinteger선택

    lost ranked elements indicates how many ranked elements of the page 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

  • featured_snippetobject선택

    ranking and traffic data from the featured snippet results in Google SERP

  • pos_1integer선택

    number of featured snippet items where the page ranks #1

  • pos_2_3integer선택

    number of featured snippet items where the page ranks #2-3

  • pos_4_10integer선택

    number of featured snippet items where the page ranks #4-10

  • pos_11_20integer선택

    number of featured snippet items where the page ranks #11-20

  • pos_21_30integer선택

    number of featured snippet items where the page ranks #21-30

  • pos_31_40integer선택

    number of featured snippet items where the page ranks #31-40

  • pos_41_50integer선택

    number of featured snippet items where the page ranks #41-50

  • pos_51_60integer선택

    number of featured snippet items where the page ranks #51-60

  • pos_61_70integer선택

    number of featured snippet items where the page ranks #61-70

  • pos_71_80integer선택

    number of featured snippet items where the page ranks #71-80

  • pos_81_90integer선택

    number of featured snippet items where the page ranks #81-90

  • pos_91_100integer선택

    number of featured snippet items where the page ranks #91-100

  • etvnumber선택

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

  • countinteger선택

    total count of featured snippet items that contain the page

  • 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 of all keywords in the category that the page ranks for 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 page

  • is_upinteger선택

    rank went up indicates how many ranked elements of the page went up

  • is_downinteger선택

    rank went down indicates how many ranked elements of the page went down

  • is_lostinteger선택

    lost ranked elements indicates how many ranked elements of the page 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

  • local_packobject선택

    ranking and traffic data from the local pack results in SERP

  • pos_1integer선택

    number of local pack items where the page ranks #1

  • pos_2_3integer선택

    number of local pack items where the page ranks #2-3

  • pos_4_10integer선택

    number of local pack items where the page ranks #4-10

  • pos_11_20integer선택

    number of local pack items where the page ranks #11-20

  • pos_21_30integer선택

    number of local pack items where the page ranks #21-30

  • pos_31_40integer선택

    number of local pack items where the page ranks #31-40

  • pos_41_50integer선택

    number of local pack items where the page ranks #41-50

  • pos_51_60integer선택

    number of local pack items where the page ranks #51-60

  • pos_61_70integer선택

    number of local pack items where the page ranks #61-70

  • pos_71_80integer선택

    number of local pack items where the page ranks #71-80

  • pos_81_90integer선택

    number of local pack items where the page ranks #81-90

  • pos_91_100integer선택

    number of local pack items where the page ranks #91-100

  • etvnumber선택

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

  • countinteger선택

    total count of local pack items that contain the page

  • 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 of all keywords in the category that the page ranks for 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 page

  • is_upinteger선택

    rank went up indicates how many ranked elements of the page went up

  • is_downinteger선택

    rank went down indicates how many ranked elements of the page went down

  • is_lostinteger선택

    lost ranked elements indicates how many ranked elements of the page 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