openapi: 3.0.1 info: title: DataForSEO AiOptimization DataforseoLabs API description: DataForSEO API is the starting point on your journey towards building powerful SEO software. With DataForSEO you can get all the data you need to build an efficient application while also saving your time and budget. DataForSEO API is using the REST technology for interchanging data between your application and our service. The data exchange is made through the widely used HTTP protocol, which allows applying our API to almost all programming languages. version: 1.0.0 servers: - url: https://api.dataforseo.com - url: https://sandbox.dataforseo.com tags: - name: DataforseoLabs paths: /v3/dataforseo_labs/id_list: post: tags: - DataforseoLabs description: 'This endpoint is designed to provide you with a list of IDs and metadata for all DataForSEO Labs tasks created within the specified time period, including both successful and uncompleted tasks. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/id_list/?bash''' operationId: DataforseoLabsIdList requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsIdListRequestInfo' nullable: true example: - datetime_from: '2026-04-12 04:39:39 +00:00' datetime_to: '2026-04-14 04:39:39 +00:00' limit: 100 offset: 0 sort: desc include_metadata: true responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsIdListResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/status: get: tags: - DataforseoLabs description: 'By calling this endpoint, you will find out when the DataForSEO Labs data was last updated. The API response will provide separate update dates for the Google, Bing, and Amazon endpoints of DataForSEO Labs API. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/status/?bash''' operationId: Status responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsStatusResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/errors: post: tags: - DataforseoLabs description: 'By calling this endpoint you will receive information about the DataForSEO Labs API tasks that returned an error within the past 7 days. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/errors/?bash''' operationId: DataforseoLabsErrors requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsErrorsRequestInfo' nullable: true example: - limit: 10 offset: 0 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsErrorsResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/available_filters: get: tags: - DataforseoLabs description: 'Here you will find all the necessary information about filters that can be used with DataForSEO Labs API endpoints. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/filters/?bash''' operationId: AvailableFilters responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAvailableFiltersResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/locations_and_languages: get: tags: - DataforseoLabs description: 'Using this endpoint you can get the full list of locations and languages supported in DataForSEO Labs API. Available sources currently include Google, Bing, and Amazon search engines. However, you should note that Amazon and Bing locations and languages are currently limited to the US/English. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages/?bash''' operationId: LocationsAndLanguages responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsLocationsAndLanguagesResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/categories: get: tags: - DataforseoLabs description: 'We use Google product and service categories. This endpoint will provide you with the full list of available categories. You can also download the CSV file by this link. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/categories_list/?bash''' operationId: Categories responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsCategoriesResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/available_history: get: tags: - DataforseoLabs description: 'By calling this endpoint, you will find obtain a list of dates available for setting in the first_date and second_date fields of the Domain Metrics by Categories endpoint. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/available_history/live/?bash''' operationId: GoogleAvailableHistory responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAvailableHistoryResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/keywords_for_site/live: post: tags: - DataforseoLabs description: 'The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain. Each keyword is supplied with relevant categories, search volume data for the last month, cost-per-click, competition, and search volume trend values for the past 12 months. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/keywords_for_site/live/?bash''' operationId: GoogleKeywordsForSiteLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForSiteLiveRequestInfo' nullable: true example: - target: apple.com language_code: en location_code: 2840 include_serp_info: true include_subdomains: true filters: - serp_info.se_results_count - '>' - 0 limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForSiteLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/related_keywords/live: post: tags: - DataforseoLabs description: 'The Related Keywords endpoint provides keywords appearing in the   "searches related to" SERP element You can get up to 4680 keyword ideas by specifying the search depth. Each related keyword comes with the list of relevant product categories, search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/related_keywords/live/?bash''' operationId: GoogleRelatedKeywordsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveRequestInfo' nullable: true example: - keyword: phone language_name: English location_code: 2840 limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/keyword_suggestions/live: post: tags: - DataforseoLabs description: 'The Keyword Suggestions endpoint provides search queries that include the specified seed keyword. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/keyword_suggestions/live/?bash''' operationId: GoogleKeywordSuggestionsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo' nullable: true example: - keyword: phone location_code: 2840 language_code: en include_serp_info: true include_seed_keyword: true limit: 1 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordSuggestionsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/keyword_ideas/live: post: tags: - DataforseoLabs description: 'The Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/keyword_ideas/live/?bash''' operationId: GoogleKeywordIdeasLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordIdeasLiveRequestInfo' nullable: true example: - keywords: - phone - watch location_code: 2840 language_code: en include_serp_info: true limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordIdeasLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/bulk_keyword_difficulty/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/bulk_keyword_difficulty/live/?bash''' operationId: GoogleBulkKeywordDifficultyLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveRequestInfo' nullable: true example: - location_code: 2840 language_code: en keywords: - dentist new york - pizza brooklyn - car dealer los angeles responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/search_intent/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword’s search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/search_intent/live/?bash''' operationId: GoogleSearchIntentLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveRequestInfo' nullable: true example: - language_code: en keywords: - login page - audi a7 - elon musk - milk store new york responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/categories_for_keywords/languages: get: tags: - DataforseoLabs description: 'Using this endpoint you can get the full list of languages supported for the Google Categories for Keywords endpoint of DataForSEO Labs API. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages/?bash''' operationId: GoogleCategoriesForKeywordsLanguages responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/categories_for_domain/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with Google product or service categories that include keywords the domain ranks for in search. Furthermore, you will obtain general rankings and traffic data for the keywords under a certain category. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/categories_for_domain/live/?bash''' operationId: GoogleCategoriesForDomainLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveRequestInfo' nullable: true example: - target: dataforseo.com language_code: en location_name: United States item_types: - paid - organic - featured_snippet - local_pack limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/categories_for_keywords/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with Google product and service categories related for each specified keyword. You can indicate a maximum of 1,000 keywords in one API request. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/live/?bash''' operationId: GoogleCategoriesForKeywordsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo' nullable: true example: - language_code: en keywords: - dentist new york - pizza brooklyn - car dealer los angeles responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/keywords_for_categories/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of keywords relevant to the specified product categories. You will get the search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values for each keyword. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/keywords_for_categories/live/?bash''' operationId: GoogleKeywordsForCategoriesLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo' nullable: true example: - category_codes: - 12191 - 12193 language_name: English location_code: 2840 include_serp_info: true limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForCategoriesLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/domain_metrics_by_categories/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with dynamics of change in metrics of domains relevant to the specified product and service categories. You will receive historical ranking data from Google SERPs, along with valuable current and historical domain metrics, such as ETV, impressions ETV, estimated paid traffic cost, the total count of SERPs that contain domains, and more. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_metrics_by_categories/live/?bash''' operationId: GoogleDomainMetricsByCategoriesLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveRequestInfo' nullable: true example: - location_code: 2840 language_code: en category_codes: - 13418 - 11494 first_date: '2026-01-15' second_date: '2026-03-15' limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/top_searches/live: post: tags: - DataforseoLabs description: 'The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics, product categories, and Google SERP data. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/top_searches/live/?bash''' operationId: GoogleTopSearchesLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleTopSearchesLiveRequestInfo' nullable: true example: - language_name: English location_code: 2840 limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleTopSearchesLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/ranked_keywords/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with the list of keywords that any domain or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as monthly searches and other data relevant to the returned keywords. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/ranked_keywords/live/?bash''' operationId: GoogleRankedKeywordsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveRequestInfo' nullable: true example: - target: dataforseo.com language_name: English location_name: United States load_rank_absolute: true limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/serp_competitors/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/serp_competitors/live/?bash''' operationId: GoogleSerpCompetitorsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveRequestInfo' nullable: true example: - keywords: - phone language_name: English location_code: 2840 item_types: - organic limit: 5 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/competitors_domain/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. In addition to that, you will get the metrics specific to the keywords both competitor domains and your domain rank for within the same SERP. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/competitors_domain/live/?bash''' operationId: GoogleCompetitorsDomainLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveRequestInfo' nullable: true example: - target: newmouth.com intersecting_domains: - dentaly.org - health.com - trysnow.com language_name: English location_code: 2840 limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/domain_intersection/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with the keywords for which both specified domains rank within the same SERP. You will get search volume, competition, cost-per-click and other data on each intersecting keyword. Along with that, you will get data on the first and second domain’s SERP element discovered for this keyword, as well as the estimated traffic volume and cost of ad traffic. Domain Intersection endpoint supports organic, paid, local pack, and featured snippet results. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_intersection/live/?bash''' operationId: GoogleDomainIntersectionLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveRequestInfo' nullable: true example: - target1: mom.com target2: quora.com language_code: en location_code: 2840 include_serp_info: true limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/subdomains/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/subdomains/live/?bash''' operationId: GoogleSubdomainsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveRequestInfo' nullable: true example: - target: dataforseo.com language_name: English location_code: 2840 filters: - - metrics.organic.pos_1 - <> - 0 - or - - metrics.organic.pos_2_3 - <> - 0 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/relevant_pages/live: post: tags: - DataforseoLabs description: for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/relevant_pages/live/?bash' operationId: GoogleRelevantPagesLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveRequestInfo' nullable: true example: - target: amazon.com language_name: English location_code: 2840 filters: - - metrics.organic.pos_1 - <> - 0 - or - - metrics.organic.pos_2_3 - <> - 0 limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/domain_rank_overview/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_rank_overview/live/?bash''' operationId: GoogleDomainRankOverviewLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveRequestInfo' nullable: true example: - target: dataforseo.com language_name: English location_code: 2840 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/historical_serps/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with Google SERPs collected within the specified time frame. You will also receive a complete overview of featured snippets and other extra elements that were present within the specified dates. The data will allow you to analyze the dynamics of keyword rankings over time for the specified keyword and location. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_serps/live/?bash''' operationId: GoogleHistoricalSerpsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveRequestInfo' nullable: true example: - keyword: albert einstein location_code: 2840 language_code: en date_from: '2026-01-15' date_to: '2026-03-15' responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/historical_rank_overview/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with historical data on rankings and traffic of the specified domain, such as domain ranking distribution in SERPs and estimated monthly traffic volume for both organic and paid results. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_rank_overview/live/?bash''' operationId: GoogleHistoricalRankOverviewLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveRequestInfo' nullable: true example: - target: dataforseo.com location_code: 2840 language_code: en date_from: '2026-01-15' date_to: '2026-03-15' responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/page_intersection/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with the keywords for which specified pages rank within the same SERP. You will get search volume, competition, cost-per-click data on each intersecting keyword. Along with that, you will get data on SERP elements that specified pages rank for in search results, as well as the estimated traffic volume and cost of ad traffic. Page Intersection endpoint supports organic, paid, local pack and featured snippet results. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/page_intersection/live/?bash''' operationId: GooglePageIntersectionLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveRequestInfo' nullable: true example: - pages: '1': https://forbes.com '2': https://cnn.com/* language_name: English location_code: 2840 include_serp_info: true limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/bulk_traffic_estimation/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/bulk_traffic_estimation/live/?bash''' operationId: GoogleBulkTrafficEstimationLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveRequestInfo' nullable: true example: - targets: - dataforseo.com - cnn.com - forbes.com location_code: 2840 language_code: en item_types: - organic - paid responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/historical_bulk_traffic_estimation/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. If you do not specify the range, data will be returned for the previous 12 months. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_bulk_traffic_estimation/live/?bash''' operationId: GoogleHistoricalBulkTrafficEstimationLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo' nullable: true example: - targets: - dataforseo.com - cnn.com - forbes.com location_code: 2840 language_code: en date_from: '2026-01-15' date_to: '2026-03-15' item_types: - organic - paid responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/historical_keyword_data/live: post: tags: - DataforseoLabs description: '  This endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. You can get historical keyword data since August, 2021, depending on keywords along with location and language combination. You can find the list of supported locations and languages here. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_keyword_data/live/?bash''' operationId: GoogleHistoricalKeywordDataLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo' nullable: true example: - language_code: en location_code: 2840 keywords: - iphone responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/keyword_overview/live: post: tags: - DataforseoLabs description: '  This endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches, as well as SERP and backlink information. Additionally, you can obtain clickstream data, such as clickstream search volume, by specifying the include_clickstream_data parameter. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/keyword_overview/live/?bash''' operationId: GoogleKeywordOverviewLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveRequestInfo' nullable: true example: - language_code: en location_code: 2840 include_clickstream_data: true include_serp_info: true keywords: - iphone responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/amazon/bulk_search_volume/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with search volume values for a maximum of 1,000 keywords in one API request. Here search volume represents the approximate number of monthly searches for a keyword on Amazon. The returned results are specific to the keywords, location, and language parameters specified in a POST request. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/amazon/bulk_search_volume/live/?bash''' operationId: AmazonBulkSearchVolumeLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveRequestInfo' nullable: true example: - keywords: - buy laptop - cheap laptops for sale - purchase laptop location_code: 2840 language_code: en responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/amazon/related_keywords/live: post: tags: - DataforseoLabs description: 'The Related Keywords endpoint provides keywords appearing in the   "Related Searches" section on Amazon. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/amazon/related_keywords/live/?bash''' operationId: AmazonRelatedKeywordsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveRequestInfo' nullable: true example: - keyword: computer mouse language_name: English location_code: 2840 limit: 5 include_seed_keyword: true responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/amazon/ranked_keywords/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of keywords the target product ranks for on Amazon. The returned results are specific to the asin specified in a POST request. Learn more about ASIN in this help center article. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/amazon/ranked_keywords/live/?bash''' operationId: AmazonRankedKeywordsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveRequestInfo' nullable: true example: - asin: B00R92CL5E location_code: 2840 language_code: en responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/amazon/product_rank_overview/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/amazon/product_rank_overview/live/?bash''' operationId: AmazonProductRankOverviewLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveRequestInfo' nullable: true example: - asins: - B001TJ3HUG - B01LW2SL7R language_name: English location_code: 2840 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/amazon/product_competitors/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/amazon/product_competitors/live/?bash''' operationId: AmazonProductCompetitorsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveRequestInfo' nullable: true example: - asin: 019005476X location_code: 2840 language_code: en responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/amazon/product_keyword_intersections/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of keywords for which the target products intersect in Amazon SERP. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/amazon/product_keyword_intersections/live/?bash''' operationId: AmazonProductKeywordIntersectionsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveRequestInfo' nullable: true example: - asins: '1': B09172433Z '2': B07GBZ4Q68 '3': B07GCKQD77 language_name: English location_code: 2840 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/bulk_app_metrics/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with ranking metrics for up to 1000 Google Play applications. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/bulk_app_metrics/live/?bash''' operationId: GoogleBulkAppMetricsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkAppMetricsLiveRequestInfo' nullable: true example: - app_ids: - org.telegram.messenger - com.zhiliaoapp.musically language_name: English location_code: 2840 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkAppMetricsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/keywords_for_app/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of keywords for which the target app ranks on Google Play. You will obtain keyword data and discover the app’s ranking position for each returned keyword. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/keywords_for_app/live/?bash''' operationId: GoogleKeywordsForAppLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveRequestInfo' nullable: true example: - app_id: org.telegram.messenger language_name: English location_code: 2840 limit: 10 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/app_competitors/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on Google Play. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/app_competitors/live/?bash''' operationId: GoogleAppCompetitorsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAppCompetitorsLiveRequestInfo' nullable: true example: - app_id: org.telegram.messenger language_name: English location_code: 2840 limit: 10 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAppCompetitorsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/google/app_intersection/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same Google Play SERP. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/google/app_intersection/live/?bash''' operationId: GoogleAppIntersectionLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAppIntersectionLiveRequestInfo' nullable: true example: - app_ids: '1': org.telegram.messenger '2': com.zhiliaoapp.musically language_name: English location_code: 2840 limit: 10 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAppIntersectionLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/apple/bulk_app_metrics/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with ranking metrics for up to 1000 App Store applications. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/apple/bulk_app_metrics/live/?bash''' operationId: AppleBulkAppMetricsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleBulkAppMetricsLiveRequestInfo' nullable: true example: - app_ids: - '686449807' - '382617920' language_name: English location_code: 2840 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleBulkAppMetricsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/apple/keywords_for_app/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of keywords for which the target app ranks on App Store. You will obtain keyword data and discover the app’s ranking position for each returned keyword. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/apple/keywords_for_app/live/?bash''' operationId: AppleKeywordsForAppLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveRequestInfo' nullable: true example: - app_id: '686449807' language_name: English location_code: 2840 limit: 10 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/apple/app_competitors/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/apple/app_competitors/live/?bash''' operationId: AppleAppCompetitorsLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleAppCompetitorsLiveRequestInfo' nullable: true example: - app_id: '686449807' language_name: English location_code: 2840 limit: 10 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleAppCompetitorsLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/dataforseo_labs/apple/app_intersection/live: post: tags: - DataforseoLabs description: 'This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same App Store SERP. for more info please visit ''https://docs.dataforseo.com/v3/dataforseo_labs/apple/app_intersection/live/?bash''' operationId: AppleAppIntersectionLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleAppIntersectionLiveRequestInfo' nullable: true example: - app_ids: '1': '686449807' '2': '382617920' language_name: English location_code: 2840 limit: 10 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleAppIntersectionLiveResponseInfo' nullable: true security: - basicAuth: [] components: schemas: BaseResponseTaskInfo: properties: id: type: string description: 'task identifier unique task identifier in our system in the UUID format' nullable: true status_code: type: integer description: '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' nullable: true status_message: type: string description: 'informational message of the task you can find the full list of general informational messages here' nullable: true time: type: string description: execution time, seconds nullable: true cost: type: number description: total tasks cost, USD format: double nullable: true result_count: type: integer description: number of elements in the result array format: int64 nullable: true path: type: array items: type: string nullable: true description: URL path nullable: true data: type: object additionalProperties: type: object nullable: true description: contains the same parameters that you specified in the POST request nullable: true DataforseoLabsleAppCompetitorsLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true app_id: type: string description: id of the competitor app nullable: true avg_position: type: number description: 'average position of the app in Google Play SERP Note: average position is calculated for intersected keywords only; the value for a given application may differ when combined with different target applications' format: float nullable: true sum_position: type: integer description: 'sum of all app positions in Google Play SERP Note: sum position is calculated for intersected keywords only; the value for a given application may differ when combined with different target applications' nullable: true intersections: type: integer description: number of intersecting keywords nullable: true competitor_metrics: type: object additionalProperties: $ref: '#/components/schemas/AppMetricsInfo' description: 'metrics for intersecting keywords ranking data relevant to the keywords that the provided competitor application shares with the app in a POST request; note: in this array ranking data is provided for the returned competitor’s app_id' nullable: true full_metrics: type: object additionalProperties: $ref: '#/components/schemas/AppMetricsInfo' description: 'metrics for all keywords of the application full overview of ranking data relevant to all keywords that the provided app_id is ranking for' nullable: true KeywordInfoNormalizedWithInfo: type: object properties: last_updated_time: type: string description: 'date and time when the dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true search_volume: type: integer description: current search volume rate of a keyword nullable: true is_normalized: type: boolean description: 'keyword info is normalized if true, values are normalized with Bing data' nullable: true monthly_searches: type: array items: type: object oneOf: - $ref: '#/components/schemas/MonthlySearchesInfo' nullable: true description: 'monthly search volume rates array of objects with search volume rates in a certain month of a year' nullable: true DataforseoLabsGoogleAppIntersectionLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAppIntersectionLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleBulkKeywordDifficultyLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleKeywordsForSiteLiveRequestInfo: type: object properties: target: type: string description: 'target domain required field the domain name of the target website the domain should be specified without https://' location_name: type: string description: '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' nullable: true location_code: type: integer description: 'unique location identifier 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' nullable: true language_name: type: string description: '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 example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language' nullable: true language_code: type: string description: '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 example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language' nullable: true include_serp_info: type: boolean description: 'include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false' nullable: true include_subdomains: type: boolean description: 'indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true limit: type: integer description: 'the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.' nullable: true offset_token: type: string description: 'offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: ["keyword_info.search_volume",">",0] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting parameter default rule: ["relevance,desc"] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["relevance,desc","keyword_info.search_volume,desc"]' nullable: true tag: type: string description: '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' nullable: true example: - target: apple.com language_code: en location_code: 2840 include_serp_info: true include_subdomains: true filters: - serp_info.se_results_count - '>' - 0 limit: 3 DataforseoLabsGoogleKeywordOverviewLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleRankedKeywordsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: target domain or webpage in a POST array nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total number of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true metrics: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: "ranking data relevant to the specified domain or webpage \nranking data is provided by the rank_group parameters that show the result’s rank considering only equivalent SERP elements" nullable: true metrics_absolute: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: 'ranking data relevant to the specified domain or webpage ranking data is provided by the rank_absolute parameters that indicate the result’s position among all SERP elements' nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveItem' nullable: true description: contains ranked keywords and related data nullable: true DataforseoLabsGoogleRelatedKeywordsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsLocationsAndLanguagesResultInfo: type: object properties: location_code: type: integer description: location code location_name: type: string description: full name of the location nullable: true location_code_parent: type: integer description: 'the code of the superordinate location the value will be null as Country is the only supported location_type for this API' nullable: true country_iso_code: type: string description: ISO country code of the location nullable: true location_type: type: string description: 'location type possible values: Country' nullable: true available_languages: type: array items: type: object oneOf: - $ref: '#/components/schemas/AvailableLanguages' nullable: true description: 'supported languages contains the languages which are supported for a specific location' nullable: true DataforseoLabsAmazonProductKeywordIntersectionsLiveRequestInfo: type: object properties: asins: type: object additionalProperties: type: string nullable: true description: 'asins of target products required field product IDs of the products for which you need to find keyword intersections; specify the ASINs as in the following example: "asins": { "1": "019005476X", "2": "0190074442" } the maximum number of ASINs you can specify in this object is 20; learn more about the parameter on this help center page' nullable: true location_name: type: string description: 'full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United Kingdom' nullable: true location_code: type: integer description: 'location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840' nullable: true language_name: type: string description: 'full name of the language required field if don’t 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 example: English' nullable: true language_code: type: string description: 'language code required field if don’t 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 example: en' nullable: true limit: type: integer description: 'the maximum number of products in the results array optional field default value: 100; maximum value: 1000' nullable: true intersection_mode: type: string description: 'mode for finding asin intersections optional field possible values: union, intersect; default value: intersect; learn more about the parameter in this help center guide' nullable: true filters: type: array items: type: object nullable: true description: '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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ["avg_position","<", 10] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting parameter example: ["sum_position,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["intersections,desc","avg_position,asc"] default rule: ["intersections,desc"]' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - asins: '1': B09172433Z '2': B07GBZ4Q68 '3': B07GCKQD77 language_name: English location_code: 2840 DataforseoLabsAppleKeywordsForAppLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' description: keyword data for the returned keyword nullable: true ranked_serp_element: type: object oneOf: - $ref: '#/components/schemas/AppleRankedSerpElementInfo' description: contains data on the domain’s SERP element found for the returned keyword nullable: true DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsErrorsTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsErrorsResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleCategoriesForDomainLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleSearchIntentLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAvailableFiltersTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAvailableFiltersResultInfo' nullable: true nullable: true DataforseoLabsGoogleBulkAppMetricsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsleBulkAppMetricsLiveItem' nullable: true description: contains data related to the ranking app metrics of the specified application nullable: true DataforseoLabsGooglePageIntersectionLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true pages: type: object additionalProperties: type: string nullable: true description: URLs you specified a POST array nullable: true exclude_pages: type: array items: type: string nullable: true description: URLs you specified in a POST array that will be excluded from the results nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveItem' nullable: true description: contains keywords, relevant SERP elements and related data nullable: true DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo' nullable: true description: array of tasks nullable: true AppStoreSearchOrganic: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank in SERP absolute position among all the elements in SERP' nullable: true position: type: string description: 'the alignment of the element in SERP can take the following values: left, right' nullable: true app_id: type: string description: id of the app nullable: true title: type: string description: title of the app nullable: true url: type: string description: URL to the app page on App Store nullable: true icon: type: string description: URL to the app icon nullable: true reviews_count: type: integer description: the total number of reviews of the app format: int64 nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: average rating of the app nullable: true is_free: type: boolean description: indicates whether the app is free nullable: true price: type: object oneOf: - $ref: '#/components/schemas/PriceInfo' description: price of the app nullable: true PriceInfo: type: object properties: current: type: number description: 'current price indicates the current price of the product or service featured in the result' format: double nullable: true regular: type: number description: 'regular price indicates the regular price of the product or service with no discounts applied' format: double nullable: true max_value: type: number description: 'the maximum price the maximum price of the product or service as indicated in the result' format: double nullable: true currency: type: string description: 'currency of the listed price ISO code of the currency applied to the price' nullable: true is_price_range: type: boolean description: 'price is provided as a range indicates whether a price is provided in a range' nullable: true displayed_price: type: string description: 'price string in the result raw price string as provided in the result' nullable: true DataforseoLabsAppleKeywordsForAppLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true app_id: type: string description: id of the app in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveItem' nullable: true description: contains data related to the ranking keywords for the app specified in the app_id field nullable: true DataforseoLabsCategoriesResultInfo: type: object properties: category_code: type: integer description: category code nullable: true category_name: type: string description: full name of the category nullable: true category_code_parent: type: integer description: 'the code of the superordinate category example: "category_code": 10178, "category_name": "Apparel Accessories", "category_code_parent": 10021 where category_code_parent corresponds to: "category_code": 10021, "category_name": "Apparel" "category_code_parent": null' nullable: true DataforseoLabsGoogleAppCompetitorsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true app_id: type: string description: id of the app in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsleAppCompetitorsLiveItem' nullable: true description: contains data related to the app_id and competitor applications nullable: true DataforseoLabsAmazonBulkSearchVolumeLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveTaskInfo' nullable: true description: array of tasks nullable: true AvailableLanguages: type: object properties: available_sources: type: array items: type: string nullable: true description: 'supported sources contains the sources of data supported for a specific location and language combination only google and bing are currently available' nullable: true language_name: type: string description: language name nullable: true language_code: type: string description: language code according to ISO 639-1 nullable: true keywords: type: integer description: the number of keywords available for the given location and language nullable: true serps: type: integer description: the number of SERP pages available for the given location and language nullable: true DataforseoLabsGoogleRelatedKeywordsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleBulkTrafficEstimationLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsleBulkAppMetricsLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true app_id: type: string description: id of the app in a POST array nullable: true metrics: type: object additionalProperties: $ref: '#/components/schemas/AppMetricsInfo' description: 'metrics for the ranking keywords of the app ranking data relevant to the keywords that the provided application ranks for on Google Play' nullable: true DataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo: type: object properties: keyword: type: string description: 'keyword required field UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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 example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language' nullable: true language_code: type: string description: '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 example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language' nullable: true include_seed_keyword: type: boolean description: 'include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false' nullable: true include_serp_info: type: boolean description: 'include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true exact_match: type: boolean description: 'search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: false' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ["keyword_info.search_volume",">",0] [["keyword_info.search_volume","in",[0,1000]], "and", ["keyword_info.competition_level","=","LOW"]][["keyword_info.search_volume",">",100], "and", [["keyword_info.cpc","<",0.5], "or", ["keyword_info.high_top_of_page_bid","<=",0.5]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 a comma is used as a separator example: ["keyword_info.competition,desc"] default rule: ["keyword_info.search_volume,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["keyword_info.search_volume,desc","keyword_info.cpc,desc"]' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.' nullable: true offset_token: type: string description: 'offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center' nullable: true tag: type: string description: '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' nullable: true example: - keyword: phone location_code: 2840 language_code: en include_serp_info: true include_seed_keyword: true limit: 1 DataforseoLabsGoogleKeywordsForSiteLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForSiteLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleBulkAppMetricsLiveRequestInfo: type: object properties: app_ids: type: array items: type: string description: 'ids of the app required field IDs of the mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger; the maximum number of IDs you can specify in this field is 1000' location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States' nullable: true location_code: type: integer description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en' nullable: true tag: type: string description: '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' nullable: true example: - app_ids: - org.telegram.messenger - com.zhiliaoapp.musically language_name: English location_code: 2840 DataforseoLabsGoogleKeywordOverviewLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleKeywordIdeasLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordIdeasLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleAvailableHistoryResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAvailableHistoryTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleSearchIntentLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsAppleAppCompetitorsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleAppCompetitorsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleDomainMetricsByCategoriesLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleAvailableHistoryResultInfo: type: object properties: date: type: string description: 'available date indicates the date of the range available for setting in the Domain Metrics by Categories endpoint example: 2022-05-16' nullable: true AmazonKeywordData: properties: se_type: type: string description: search engine type nullable: true keyword: type: string description: related keyword nullable: true location_code: type: integer description: location code in a POST array format: int64 nullable: true language_code: type: string description: language code in a POST array nullable: true keyword_info: type: object oneOf: - $ref: '#/components/schemas/AmazonKeywordInfo' description: keyword info for the returned keyword nullable: true DataforseoLabsAppleAppIntersectionLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true app_ids: type: object additionalProperties: type: string nullable: true description: ids of the apps in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsleAppIntersectionLiveItem' nullable: true description: contains data related to the ranking keywords for the app specified in the app_id field nullable: true DataforseoLabsGoogleTopSearchesLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleTopSearchesLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAmazonProductKeywordIntersectionsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true asins: type: object additionalProperties: type: string nullable: true description: ASINs in a POST array nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveItem' nullable: true description: contains detected Amazon product competitors and related data nullable: true DataforseoLabsGoogleKeywordsForAppLiveRequestInfo: type: object properties: app_id: type: string description: 'id of the apps required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger' location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States' nullable: true location_code: type: integer description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en' nullable: true filters: type: array items: type: object nullable: true description: '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: <, <=, >, >=, =, <>, in, not_in example: ["keyword_data.keyword_info.search_volume",">",500] [["keyword_data.keyword_info.search_volume","<>",500],"and",["ranked_serp_element.serp_item.rank_group",">=","10"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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: ["ranked_serp_element.serp_item.rank_group,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: ["ranked_serp_element.serp_item.rank_group,desc","keyword_data.keyword_info.search_volume,asc"] default rule: ["keyword_data.keyword_info.search_volume,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' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - app_id: org.telegram.messenger language_name: English location_code: 2840 limit: 10 DataforseoLabsGooglePageIntersectionLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveResultInfo' nullable: true description: array of results nullable: true HistoricalMetricsBundleInfo: type: object properties: organic: type: array items: type: object oneOf: - $ref: '#/components/schemas/HistoricalMetricsInfo' nullable: true description: traffic data from organic search nullable: true paid: type: array items: type: object oneOf: - $ref: '#/components/schemas/HistoricalMetricsInfo' nullable: true description: traffic data from paid search nullable: true local_pack: type: array items: type: object oneOf: - $ref: '#/components/schemas/HistoricalMetricsInfo' nullable: true description: traffic data from the local pack results in SERP nullable: true featured_snippet: type: array items: type: object oneOf: - $ref: '#/components/schemas/HistoricalMetricsInfo' nullable: true description: traffic data from the featured snippet results in Google SERP nullable: true DataforseoLabsAmazonProductKeywordIntersectionsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo: type: object properties: keywords: type: array items: type: string description: 'keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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' nullable: true language_code: type: string description: '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' nullable: true tag: type: string description: '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' nullable: true example: - language_code: en location_code: 2840 keywords: - iphone AmazonInfo: type: object properties: se_type: type: string description: search engine type nullable: true type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank in Amazon SERP absolute position among all the elements in SERP' nullable: true position: type: string description: 'the alignment of the element in Amazon SERP can take the following values: left, right' nullable: true xpath: type: string description: the XPath of the element nullable: true domain: type: string description: Amazon domain nullable: true title: type: string description: product title nullable: true url: type: string description: URL of the product page nullable: true asin: type: string description: 'ASIN of the product learn more about ASIN in this help center guide' nullable: true image_url: type: string description: URL of the product image featured in the results nullable: true price_from: type: number description: 'the regular price of a product example: 49.98' nullable: true price_to: type: number description: 'the upper limit of the product price range example: 384.99' nullable: true currency: type: string description: 'currency in the ISO format example: USD' nullable: true special_offers: type: array items: type: string nullable: true description: 'special offer details contains special offer details, including coupon and Subscribe & Save discounts' nullable: true is_best_seller: type: boolean description: '“Best Seller” label if the value is true, the product is marked with the “Best Seller” label' nullable: true is_amazon_choice: type: boolean description: '“Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label' nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' properties: value: type: number description: the value of the rating format: float nullable: true description: "the item’s rating \nthe popularity rate based on reviews and displayed in SERP" nullable: true delivery_info: type: object oneOf: - $ref: '#/components/schemas/AmazonDeliveryInfo' description: 'delivery information delivery information including free and fast delivery date ranges' nullable: true bought_past_month: type: integer nullable: true DataforseoLabsGoogleHistoricalSerpsLiveResultInfo: type: object properties: se_type: type: string description: search engine type in a POST array nullable: true keyword: type: string description: 'keyword received in a POST array the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)' nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: the total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveItem' nullable: true description: 'additional items present in the element if there are none, equals null' nullable: true DataforseoLabsCategoriesResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsCategoriesTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleDomainIntersectionLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true target1: type: string description: the first target domain in a POST array nullable: true target2: type: string description: the second target domain in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveItem' nullable: true description: contains keywords, relevant SERP elements and related data nullable: true DataforseoLabsAppleBulkAppMetricsLiveRequestInfo: type: object properties: app_ids: type: array items: type: string description: 'ids of the apps required field IDs of mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; the maximum number of IDs you can specify in this field is 1000' location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States' nullable: true location_code: type: integer description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en' nullable: true tag: type: string description: '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' nullable: true example: - app_ids: - '686449807' - '382617920' language_name: English location_code: 2840 DataforseoLabsGoogleRankedKeywordsLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' description: keyword data for the returned keyword nullable: true ranked_serp_element: type: object oneOf: - $ref: '#/components/schemas/RankedSerpElement' description: contains data on the domain’s SERP element found for the returned keyword nullable: true DataforseoLabsAmazonRankedKeywordsLiveRequestInfo: type: object properties: asin: type: string description: 'product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint' location_name: type: string description: 'full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States' nullable: true location_code: type: integer description: 'location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840' nullable: true language_name: type: string description: 'full name of the language required field if don’t 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 example: English' nullable: true language_code: type: string description: 'language code required field if don’t 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 example: en' nullable: true limit: type: integer description: 'the maximum number of products in the results array optional field default value: 100; maximum value: 1000' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true filters: type: array items: type: object nullable: true description: '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, like, not_like, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["keyword_data.keyword_info.search_volume","in",[100,1000]]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting parameter example: ["keyword_data.keyword_info.competition,desc"] default rule: ["ranked_serp_element.serp_item.rank_group,asc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - asin: B00R92CL5E location_code: 2840 language_code: en DataforseoLabsGoogleRelevantPagesLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true page_address: type: string description: absolute URL of the relevant page nullable: true metrics: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: rankings and traffic metrics for the relevant page nullable: true DataforseoLabsGoogleRelatedKeywordsLiveItem: type: object properties: se_type: type: string description: 'search engine type possible values: google' nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' properties: avg_backlinks_info: type: object oneOf: - $ref: '#/components/schemas/AvgBacklinksInfo' nullable: true search_intent_info: type: object oneOf: - $ref: '#/components/schemas/SearchIntentInfo' nullable: true description: keyword data for the returned keyword nullable: true depth: type: integer description: keyword search depth nullable: true related_keywords: type: array items: type: string nullable: true description: 'list of related keywords represents the list of search queries which are related to the keyword returned in the array above' nullable: true DataforseoLabsGoogleRelevantPagesLiveRequestInfo: type: object properties: target: type: string description: 'domain required field the domain name of the target website the domain should be specified without https:// and www.' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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' nullable: true language_code: type: string description: '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' nullable: true item_types: type: array items: type: string description: '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"]' nullable: true include_clickstream_data: type: boolean description: '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' nullable: true limit: type: integer description: 'the maximum number of returned pages optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: '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' nullable: true historical_serp_mode: type: string description: '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' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true filters: type: array items: type: object nullable: true description: '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' nullable: true order_by: type: array items: type: string description: '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' nullable: true tag: type: string description: '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' nullable: true example: - target: amazon.com language_name: English location_code: 2840 filters: - - metrics.organic.pos_1 - <> - 0 - or - - metrics.organic.pos_2_3 - <> - 0 limit: 3 HistoricalMetricsInfo: type: object properties: year: type: integer description: year for which the data is provided nullable: true month: type: integer description: month for which the data is provided nullable: true etv: type: number description: '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' nullable: true count: type: integer description: total count of organic SERPs that contain the domain format: int64 nullable: true DataforseoLabsIdListResultInfo: type: object properties: id: type: string description: id of the task nullable: true url: type: string description: 'URL of the task URL you used for making an API call' nullable: true datetime_posted: type: string description: 'date and time when the task was made in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00' nullable: true datetime_done: type: string description: 'date and time when the task was completed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00' nullable: true status: type: string description: 'informational message of the task you can find the full list of general informational messages here' nullable: true cost: type: number description: cost of the task, USD nullable: true metadata: type: object additionalProperties: type: object nullable: true description: contains parameters you specified in the POST request nullable: true DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleKeywordsForAppLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true app_id: type: string description: id of the app in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveItem' nullable: true description: contains data related to the ranking keywords for the app specified in the app_id field nullable: true DataforseoLabsGoogleHistoricalSerpsLiveItem: type: object properties: se_type: type: string description: search engine type in a POST array nullable: true keyword: type: string description: 'keyword received in a POST array the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)' nullable: true type: type: string description: type of element nullable: true se_domain: type: string description: search engine domain in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true check_url: type: string description: 'direct URL to search engine results you can use it to make sure that we provided accurate results' nullable: true datetime: type: string description: 'date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true spell: type: object oneOf: - $ref: '#/components/schemas/SpellInfo' description: 'autocorrection of the search engine if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection' nullable: true item_types: type: array items: type: string nullable: true description: 'types of search results in SERP contains types of search results (items) found in SERP. possible item types: answer_box, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, ai_overview' nullable: true se_results_count: type: integer description: total number of results in SERP format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem' nullable: true description: contains results featured in the ‘hotels_pack’ element of SERP nullable: true DataforseoLabsGoogleSearchIntentLiveItem: type: object properties: keyword: type: string description: target keyword in a POST array nullable: true keyword_intent: type: object oneOf: - $ref: '#/components/schemas/KeywordIntentInfo' description: search intent data relevant for the specified keyword nullable: true secondary_keyword_intents: type: array items: type: object oneOf: - $ref: '#/components/schemas/KeywordIntentInfo' nullable: true description: contains objects with other possible search intents for the specified keyword nullable: true DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveItem' nullable: true description: contains keywords and related data nullable: true DataforseoLabsGooglePageIntersectionLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGooglePageIntersectionLiveRequestInfo: type: object properties: pages: type: object additionalProperties: type: string nullable: true description: 'target URLs of pages required field you can set up to 20 pages in this object the pages should be specified with absolute URLs (including http:// or https://) example: "pages": { "1":"https://www.apple.com/mac/*", "2":"https://dataforseo.com/*", "3":"https://support.microsoft.com/" }if you specify a single page here, we will return results only for this page; you can also use a wildcard (‘*’) character to specify the search pattern example: "example.com" search for the exact URL "example.com/eng/*" search for the example.com page and all its related URLs which start with ‘/eng/’, such as “example.com/eng/index.html” and “example.com/eng/help/”, etc. note: a wilcard should be placed after the slash (‘/’) character in the end of the URL, it is not possible to place it after the domain in the following way: https://dataforseo.com* use https://dataforseo.com/* instead Note: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million' nullable: true exclude_pages: type: array items: type: string description: 'URLs of pages you want to exclude optional field you can set up to 10 pages in this array if you use this array, results will contain the keywords for which URLs from the pages object rank, but URLs from exclude_pages array do not; note that if you specify this field, the results will be based on the keywords any URL from pages ranks for regardless of intersections between them. However, you can set intersection_mode to intersect and results will contain the keywords all URLs from pages rank for in the same SERP and URLs from exclude_pages do not. use a wildcard (‘*’) character to specify the search pattern example: "exclude_pages": [ "https://www.apple.com/iphone/*", "https://dataforseo.com/apis/*", "https://www.microsoft.com/en-us/industry/services/" ]' nullable: true location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en' nullable: true item_types: type: array items: type: string description: 'search results type indicates type of search results included in the response optional field possible values: ["organic", "paid", "featured_snippet", "local_pack"] default value: ["organic", "paid"]' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the items array of returned keywords optional field default value: 0 if you specify 10 here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true include_subdomains: type: boolean description: 'indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true' nullable: true intersection_mode: type: string description: 'indicates whether to intersect keywords optional field use this field to intersect or merge results for the specified URLs possible values: union, intersect union – results are based on all keywords any URL from pages rank for; intersect – results are based on the keywords all URLs from pages rank for in the same SERP: by default, results are based on the intersect mode if you specify only pages array. If you specify exclude_pages as well, results are based on the union mode' nullable: true include_serp_info: type: boolean description: 'include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true filters: type: array items: type: object nullable: true description: '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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters note that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding page for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter: [intersection_result.1.rank_absolute,"=",1] if you want to filter results and receive only organic listings for the third specified URL, you should set the following filter: [intersection_result.3.type,"=","organic"] , etc.example: ["keyword_data.keyword_info.search_volume","in",[100,1000]] [["intersection_result.1.etv",">",0],"and",["intersection_result.1.description","like","%goat%"]][["keyword_data.keyword_info.search_volume",">",100], "and", [["intersection_result.2.description","like","%goat%"], "or", ["intersection_result.2.type","=","organic"]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting parameter example: ["keyword_data.keyword_info.competition,desc"] default rule: ["keyword_data.keyword_info.search_volume,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["intersection_result.1.rank_group,asc","intersection_result.2.rank_absolute,asc"]' nullable: true tag: type: string description: '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' nullable: true example: - pages: '1': https://forbes.com '2': https://cnn.com/* language_name: English location_code: 2840 include_serp_info: true limit: 3 DataforseoLabsAppleBulkAppMetricsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleBulkAppMetricsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleDomainRankOverviewLiveRequestInfo: type: object properties: target: type: string description: 'domain required field the domain name of the target website the domain should be specified without https:// and www.' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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' nullable: true language_code: type: string description: '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' nullable: true ignore_synonyms: type: boolean description: 'ignore highly similar keywords optional field if set to true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value: false' nullable: true limit: type: integer description: 'the maximum number of returned results for domain optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items' nullable: true tag: type: string description: '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' nullable: true example: - target: dataforseo.com language_name: English location_code: 2840 DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAmazonBulkSearchVolumeLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: target domain in a POST array nullable: true metrics: type: object oneOf: - $ref: '#/components/schemas/HistoricalMetricsBundleInfo' description: traffic data relevant to the specified domain nullable: true MonthlySearchesInfo: type: object properties: year: type: integer description: year nullable: true month: type: integer description: month nullable: true search_volume: type: integer description: monthly average search volume rate nullable: true DataforseoLabsAmazonRelatedKeywordsLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/AmazonKeywordData' description: keyword data for the returned keyword nullable: true depth: type: integer description: keyword search depth nullable: true related_keywords: type: array items: type: string description: 'list of related keywords represents the list of search queries which are related to the keyword returned in the array above' nullable: true DataforseoLabsIdListRequestInfo: type: object properties: datetime_from: type: string description: 'start time for filtering results required field if include_metadata is set to true, maximum value: a month from current datetime; if include_metadata is set to false, maximum value: six months from current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00' datetime_to: type: string description: 'finish time for filtering results required field maximum value: current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-31 13:57:46 +00:00' limit: type: integer description: 'the maximum number of returned task IDs optional field default value: 1000 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned task IDs optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted' nullable: true sort: type: string description: 'sorting by task execution time optional field possible values: "asc", "desc" default value: "asc"' nullable: true include_metadata: type: boolean description: 'include task metadata in the respond optional field default value: false' nullable: true example: - datetime_from: '2026-04-12 04:39:39 +00:00' datetime_to: '2026-04-14 04:39:39 +00:00' limit: 100 offset: 0 sort: desc include_metadata: true DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleTopSearchesLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true offset: type: integer description: current offset value nullable: true offset_token: type: string description: 'offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task' nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' nullable: true description: contains keywords and related data nullable: true DataforseoLabsGoogleBulkTrafficEstimationLiveRequestInfo: type: object properties: targets: type: array items: type: string description: 'target domains, subdomains, and webpages required field you can specify domains, subdomains, and webpages in this field; domains and subdomains should be specified without https:// and www.; pages should be specified with absolute URL, including https:// and www.; you can set up to 1000 domains, subdomains or webpages' location_name: type: string description: 'full name of the location if you use this field, you don’t have 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' nullable: true location_code: type: integer description: 'location code if you use this field, you don’t have 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' nullable: true language_name: type: string description: 'full name of the language 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' nullable: true language_code: type: string description: 'language code 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' nullable: true item_types: type: array items: type: string description: '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 possible values: ["organic", "paid", "featured_snippet", "local_pack"] default value: ["organic", "paid"]' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true tag: type: string description: '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' nullable: true example: - targets: - dataforseo.com - cnn.com - forbes.com location_code: 2840 language_code: en item_types: - organic - paid DataforseoLabsGoogleCompetitorsDomainLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveTaskInfo' nullable: true description: array of tasks nullable: true RankedSerpElement: type: object properties: se_type: type: string description: search engine type nullable: true serp_item: type: object oneOf: - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem' description: 'contains data on the SERP element the list of supported SERP elements can be found below' nullable: true check_url: type: string description: 'direct URL to search engine results you can use it to make sure that we provided accurate results' nullable: true serp_item_types: type: array items: type: string nullable: true description: 'types of search results in SERP contains types of search results (items) found in SERP all possible item types can be found here, they include: answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box; note that the actual results will be returned only for organic, paid, featured_snippet, local_pack, and ai_overview_reference elements' nullable: true se_results_count: type: integer description: number of search results for the returned keyword format: int64 nullable: true keyword_difficulty: type: integer description: 'difficulty of ranking in the first top-10 organic results for a keyword indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100; calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP' nullable: true is_lost: type: boolean description: 'lost ranked elements indicates how many ranked elements of this target were previously presented in SERPs, but weren’t found during the last check' nullable: true last_updated_time: type: string description: 'date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true previous_updated_time: type: string description: 'previous to the most recent date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-10-15 12:57:46 +00:00' nullable: true DataforseoLabsGoogleAppIntersectionLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAppIntersectionLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleCompetitorsDomainLiveRequestInfo: type: object properties: target: type: string description: 'domain required field the domain name of the target website the domain should be specified without https:// and www. you can specify page URL, but the results will be specific to the domain in the specified URL' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en' nullable: true item_types: type: array items: type: string description: '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"]' nullable: true include_clickstream_data: type: boolean description: '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' nullable: true filters: type: array items: type: object nullable: true description: '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.organic.count",">",50] [[["metrics.organic.count",">=",50],"and",["metrics.organic.pos_1","in",[1,5]]], "or", ["metrics.organic.etv",">=","100"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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' nullable: true limit: type: integer description: 'the maximum number of returned domains optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true max_rank_group: type: integer description: 'maximum rank up to which competitors will be considered optional field default value: 100 if you specify 10 here, we will extract competitors from the top 10 Google search results only' nullable: true exclude_top_domains: type: boolean description: 'indicates whether to exclude world’s largest websites optional field default value: false set to true if you want to get highly-relevant competitors excluding the websites listed below: wikipedia.org pinterest.com amazon.com google.com facebook.com wordpress.com medium.com quora.com reddit.com youtube.com ebay.com uol.com.br instagram.com olx.com twitter.com linkedin.com slideshare.net' nullable: true exclude_domains: type: array items: type: string description: 'exclude domains from the results optional field use this parameter to exclude specific domains from the results Note: you can specify up to 1000 domains in this array example: "exclude_domains": [ "reddit.com", "youtube.com" ]' nullable: true intersecting_domains: type: array items: type: string description: 'additional domains for improving results accuracy optional field to improve the accuracy of the result, you can specify domains that are known to intersect with the target in SERPs; if you use this array, metrics in the result will be based on SERPs where both target website and intersecting_domains appear; Note: you can specify up to 20 domains in this array' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true tag: type: string description: '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' nullable: true example: - target: newmouth.com intersecting_domains: - dentaly.org - health.com - trysnow.com language_name: English location_code: 2840 limit: 3 DataforseoLabsStatusResultInfo: type: object properties: google: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsStatusInfo' description: update information for the Google endpoints nullable: true bing: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsStatusInfo' description: update information for the Bing endpoints nullable: true amazon: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsStatusInfo' description: update information for the Amazon endpoints nullable: true DataforseoLabsStatusResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsStatusTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo: type: object properties: category_codes: type: array items: type: string description: 'product and service categories required field The maximum number of categories you can specify: 20 you can download the full list of possible categories' location_name: type: string description: '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' nullable: true location_code: type: integer description: 'unique location identifier 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' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English' nullable: true language_code: type: string description: 'unique language identifier 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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en' nullable: true category_intersection: type: boolean description: 'category intersections optional field if set to true, you will get keywords featured in all specified categories; if set to false, you will keywords that are specified in any of the specified categories; default value: true' nullable: true include_serp_info: type: boolean description: 'include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true limit: type: integer description: 'the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.' nullable: true offset_token: type: string description: 'offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters example: ["keyword_info.search_volume",">",0] [["keyword_info.search_volume","in",[0,1000]], "and", ["keyword_info.competition_level","=","LOW"]] [["keyword_info.search_volume",">",100], "and", [["keyword_info.cpc","<",0.5], "or", ["keyword_info.high_top_of_page_bid","<=",0.5]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting type example: ["keyword_info.competition,desc"] default rule: ["keyword_info.search_volume,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["keyword_info.search_volume,desc","keyword_info.competition,asc"]' nullable: true tag: type: string description: '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' nullable: true example: - category_codes: - 12191 - 12193 language_name: English location_code: 2840 include_serp_info: true limit: 3 DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleRelevantPagesLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAppleAppIntersectionLiveRequestInfo: type: object properties: app_ids: type: object additionalProperties: type: string nullable: true description: 'ids of the target apps required field IDs of the target mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; the ids should be specified the following way: "app_ids": { "1": "686449807", "2": "382617920" } if you specify a single ID here, the API will return results only for one application; the maximum number of app IDs you can specify in this object is 20' nullable: true location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States' nullable: true location_code: type: integer description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en' nullable: true filters: type: array items: type: object nullable: true description: '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: <, <=, >, >=, =, <>, in, not_in example: ["keyword_data.keyword_info.search_volume",">",500] [["keyword_data.keyword_info.search_volume","<>",500],"and",[intersection_result.382617920.rank_group",">=","10"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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: ["intersection_result.382617920.rank_absolute,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: ["intersection_result.382617920.rank_absolute,desc","keyword_data.keyword_info.search_volume,asc"] default rule: ["keyword_data.keyword_info.search_volume,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' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - app_ids: '1': '686449807' '2': '382617920' language_name: English location_code: 2840 limit: 10 DataforseoLabsGoogleSerpCompetitorsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true seed_keywords: type: array items: type: string nullable: true description: 'keywords specified in the request keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)' nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: the total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveItem' nullable: true description: contains detected SERP competitors and related data nullable: true DataforseoLabsGoogleHistoricalSerpsLiveRequestInfo: type: object properties: keyword: type: string description: 'keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B”' date_from: type: string description: 'starting date of the time range optional field if you don’t specify this field, the API will return all SERPs collected for 365 days starting from the current datetime value; minimal possible value: 365 days from the current datetime value; date format: "yyyy-mm-dd"' nullable: true date_to: type: string description: '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-09-01"' nullable: true location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom' nullable: true location_code: type: integer description: 'unique location identifier 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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English' nullable: true language_code: type: string description: 'unique language identifier 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 languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en' nullable: true tag: type: string description: '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' nullable: true example: - keyword: albert einstein location_code: 2840 language_code: en date_from: '2026-01-15' date_to: '2026-03-15' DataforseoLabsAmazonProductRankOverviewLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAmazonRankedKeywordsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleRelevantPagesLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleBulkTrafficEstimationLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: target domain in a POST array nullable: true metrics: type: object oneOf: - $ref: '#/components/schemas/BulkMetricsBundleInfo' description: traffic data relevant to the specified domain nullable: true DataforseoLabsGoogleBulkKeywordDifficultyLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword: type: string description: keyword in a POST array nullable: true keyword_difficulty: type: integer description: 'difficulty of ranking in the first top-10 organic results for a keyword indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100; calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP; learn more about the metric in this help center guide' nullable: true DataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true seed_categories: type: array items: type: integer nullable: true description: categories in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: the total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true offset: type: integer description: current offset value nullable: true offset_token: type: string description: 'offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task' nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' nullable: true description: contains keyword ideas and related data nullable: true DataforseoLabsGoogleCategoriesForKeywordsLiveItem: type: object properties: keyword: type: string description: keyword in a POST array nullable: true categories: type: array items: type: integer description: 'product and service categories you can download the full list of possible categories' nullable: true DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleDomainMetricsByCategoriesLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true top_categories: type: array items: type: integer nullable: true description: categories for which domains are collected nullable: true organic_etv: type: number description: current organic ETV of the domain nullable: true organic_count: type: integer description: current total count of organic SERPs that contain the domain format: int64 nullable: true organic_is_lost: type: integer description: 'current number of lost ranked elements indicates how many ranked elements of the domain were previously presented in SERPs, but weren’t found during the last check' nullable: true organic_is_new: type: integer description: 'current number of new ranked elements indicates how many new ranked elements were found for the domain' nullable: true domain: type: string description: domain found for the specified category nullable: true main_domain: type: string description: primary domain nullable: true metrics_history: type: object additionalProperties: type: object additionalProperties: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsMetricsInfo' nullable: true description: historical ranking and traffic data of the domain nullable: true metrics_difference: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: 'metrics difference between first_date and second_date calculated by subtracting domain metrics as of the greater date from domain metrics as of the smaller date' nullable: true DataforseoLabsGoogleCategoriesForDomainLiveRequestInfo: type: object properties: target: type: string description: 'domain or subdomain required field the domain or subdomain name of the target website the domain or subdomain should be specified without https:// and www.' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en' nullable: true include_subcategories: type: boolean description: 'indicates if the subcategories will be included in the search optional field if set to false, the subcategories will be ignored default value: false learn more about the parameter in this help center article' nullable: true include_clickstream_data: type: boolean description: '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' nullable: true historical_serp_mode: type: string description: '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' nullable: true item_types: type: array items: type: string description: '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 the organic object, 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"]' nullable: true filters: type: array items: type: object nullable: true description: '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.organic.pos_1,">",0] [[["metrics.organic.count",">=",100],"and",["metrics.organic.pos_1",">",0]], "or", ["metrics.organic.etv","in",[10,100]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 the organic object, the results will be ordered by the first item type in the array' nullable: true limit: type: integer description: 'the maximum number of returned categories optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: "offset in the results array of returned categories \noptional field\ndefault value: 0\nif you specify the 10 value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories" nullable: true tag: type: string description: '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' nullable: true example: - target: dataforseo.com language_code: en location_name: United States item_types: - paid - organic - featured_snippet - local_pack limit: 3 DataforseoLabsGoogleKeywordsForSiteLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: target domain in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total number of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true offset: type: integer description: current offset value nullable: true offset_token: type: string description: 'offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task' nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' nullable: true description: contains keyword ideas and related data nullable: true SearchVolumeTrend: type: object properties: monthly: type: integer description: search volume change in percent compared to the previous month nullable: true quarterly: type: integer description: search volume change in percent compared to the previous quarter nullable: true yearly: type: integer description: search volume change in percent compared to the previous year nullable: true DataforseoLabsGoogleSerpCompetitorsLiveRequestInfo: type: object properties: keywords: type: array items: type: string description: 'keywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; you can specify the maximum of 200 keywords learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: '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 location_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom' nullable: true location_code: type: integer description: 'unique location identifier 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 parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English' nullable: true language_code: type: string description: 'unique language identifier 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 languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en' nullable: true include_subdomains: type: boolean description: 'indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true' nullable: true item_types: type: array items: type: string description: 'search results type indicates type of search results included in the response optional field possible values: ["organic", "paid", "featured_snippet", "local_pack"] default value: ["organic", "paid"]' nullable: true limit: type: integer description: 'the maximum number of returned domains optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ["median_position","in",[1,10]] [["median_position","in",[1,10]],"and",["domain","not_like","%wikipedia.org%"]] [["domain","not_like","%wikipedia.org%"], "and", [["relevant_serp_items",">",0],"or",["median_position","in",[1,10]]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 the comma is used as a separator example: ["avg_position,asc"] default rule: ["rating,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["avg_position,asc","etv,desc"]' nullable: true tag: type: string description: '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' nullable: true example: - keywords: - phone language_name: English location_code: 2840 item_types: - organic limit: 5 DataforseoLabsAppleBulkAppMetricsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsleBulkAppMetricsLiveItem' nullable: true description: contains data related to the ranking app metrics of the specified application nullable: true DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true seed_keyword: type: string description: keyword in a POST array nullable: true seed_keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' description: 'keyword data for the seed keyword fields in this object are identical to those of the items array' nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true offset: type: integer description: current offset value nullable: true offset_token: type: string description: 'offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task' nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' nullable: true description: contains keywords and related data nullable: true DataforseoLabsErrorsRequestInfo: type: object properties: limit: type: integer description: 'the maximum number of returned tasks that responded with an error optional field default value: 1000 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned tasks optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks' nullable: true filtered_function: type: string description: 'return tasks with a certain function use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the function fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by function example: dataforseo_labs/related_keywords/live' nullable: true datetime_from: type: string description: 'start time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 12:57:46 +00:00' nullable: true datetime_to: type: string description: 'finish time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 13:57:46 +00:00' nullable: true example: - limit: 10 offset: 0 DataforseoLabsAmazonProductRankOverviewLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveItem' nullable: true description: contains detected Amazon product competitors and related data nullable: true AppleRankedSerpElementInfo: type: object properties: se_type: type: string description: search engine type nullable: true serp_item: type: object oneOf: - $ref: '#/components/schemas/AppStoreSearchOrganic' description: 'contains data on the SERP element the list of supported SERP elements can be found below' nullable: true check_url: type: string description: 'direct URL to search engine results you can use it to make sure that we provided accurate results' nullable: true se_results_count: type: integer description: number of search results for the returned keyword nullable: true last_updated_time: type: string description: 'date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true previous_updated_time: type: string description: 'previous to the most recent date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-10-15 12:57:46 +00:00; in this case, will equal null' nullable: true GooglePlaySearchOrganic: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank in SERP absolute position among all the elements in SERP' nullable: true position: type: string description: 'the alignment of the element in SERP can take the following values: left, right' nullable: true app_id: type: string description: id of the app nullable: true title: type: string description: title of the app nullable: true url: type: string description: URL to the app page on Google Play nullable: true icon: type: string description: URL to the app icon nullable: true reviews_count: type: integer description: the total number of reviews of the app format: int64 nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: average rating of the app nullable: true is_free: type: boolean description: indicates whether the app is free nullable: true price: type: object oneOf: - $ref: '#/components/schemas/PriceInfo' description: price of the app nullable: true developer: type: string description: name of the app developer nullable: true developer_url: type: string description: URL to the developer page on Google Play nullable: true DataforseoLabsGoogleAppIntersectionLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true app_ids: type: object additionalProperties: type: string nullable: true description: ids of the apps in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsleAppIntersectionLiveItem' nullable: true description: contains data related to the ranking keywords for the app specified in the app_id field nullable: true DataforseoLabsGoogleSubdomainsLiveRequestInfo: type: object properties: target: type: string description: 'domain required field the domain name of the target website the domain should be specified without https:// and www.' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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' nullable: true language_code: type: string description: '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' nullable: true item_types: type: array items: type: string description: '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"]' nullable: true include_clickstream_data: type: boolean description: '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' nullable: true historical_serp_mode: type: string description: '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' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true filters: type: array items: type: object nullable: true description: '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.paid.count",">",0],"and",["metrics.paid.etv",">","50"]] [["metrics.organic.count",">","10"], "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' nullable: true order_by: type: array items: type: string description: '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' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - target: dataforseo.com language_name: English location_code: 2840 filters: - - metrics.organic.pos_1 - <> - 0 - or - - metrics.organic.pos_2_3 - <> - 0 DataforseoLabsGoogleBulkKeywordDifficultyLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveResultInfo' nullable: true description: array of results nullable: true SerpInfo: type: object properties: se_type: type: string description: search engine type nullable: true check_url: type: string description: 'direct URL to search engine results you can use it to make sure that we provided accurate results' nullable: true serp_item_types: type: array items: type: string nullable: true description: 'types of search results in SERP contains types of search results (items) found in SERP possible item types: answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses, ai_overview; note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements' nullable: true se_results_count: type: integer description: number of search results for the returned keyword format: int64 nullable: true last_updated_time: type: string description: 'date and time when search intent data was last updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true previous_updated_time: type: string description: 'previous to the most recent date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-10-15 12:57:46 +00:00' nullable: true DataforseoLabsGoogleSubdomainsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleCompetitorsDomainLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true domain: type: string description: domain name nullable: true avg_position: type: number description: 'average position of the domain in SERP Note: average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites' format: float nullable: true sum_position: type: integer description: 'sum of all domain positions in SERP Note: average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites' nullable: true intersections: type: integer description: number of intersecting keywords nullable: true full_domain_metrics: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: 'metrics for all keywords of the domain full overview of ranking and traffic data relevant to all keywords that the provided domain is ranking for' nullable: true metrics: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: 'metrics for intersecting keywords ranking and traffic data relevant to the keywords that the provided domain shares with the target domain note: in this array ranking and traffic data is provided for the target considering the keywords target shares in search with the competitor’s domain' nullable: true competitor_metrics: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: 'metrics for intersecting keywords ranking and traffic data relevant to the keywords that the provided domain shares with the target domain note: in this array ranking and traffic data is provided for the returned competitor’s domain' nullable: true DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsCategoriesTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsCategoriesResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleBulkTrafficEstimationLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveItem' nullable: true description: array of items with relevant traffic estimation data nullable: true DataforseoLabsAmazonProductCompetitorsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true asin: type: string description: ASIN in a POST array nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveItem' nullable: true description: contains detected Amazon product competitors and related data nullable: true DataforseoLabsGoogleBulkKeywordDifficultyLiveRequestInfo: type: object properties: keywords: type: array items: type: string description: 'target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: 'full name of the location required field if don’t 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 example: United Kingdom' nullable: true location_code: type: integer description: 'location code required field if don’t 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 example: 2840' nullable: true language_name: type: string description: 'full name of the language required field if don’t 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 example: English' nullable: true language_code: type: string description: 'language code required field if don’t 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 example: en' nullable: true tag: type: string description: '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' nullable: true example: - location_code: 2840 language_code: en keywords: - dentist new york - pizza brooklyn - car dealer los angeles AppMetricsInfo: type: object properties: pos_1: type: integer description: 'number of organic SERPs where the product ranks #1' nullable: true pos_2_3: type: integer description: 'number of organic SERPs where the product ranks #2-3' nullable: true pos_4_10: type: integer description: 'number of organic SERPs where the product ranks #4-10' nullable: true pos_11_100: type: integer description: 'number of organic SERPs where the product ranks #11-100' nullable: true count: type: integer description: total count of Amazon organic SERPs that contain the product format: int64 nullable: true search_volume: type: integer description: total search volume of the product’s ranking keywords in organic SERP format: int64 nullable: true DataforseoLabsGoogleSearchIntentLiveResultInfo: type: object properties: language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveItem' nullable: true description: array of items with relevant traffic estimation data nullable: true SpellInfo: properties: keyword: type: string description: "keyword obtained as a result of search engine autocorrection\n the results will be provided for the corrected keyword" nullable: true type: type: string description: "type of autocorrection\n possible values:\n did_you_mean, showing_results_for, no_results_found_for, including_results_for\n note: Yahoo and Yandex support only the following autocorrection type:\n including_results_for" nullable: true DataforseoLabsGoogleCategoriesForDomainLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: target domain or subdomain in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveItem' nullable: true description: contains relevant categories and related ranking data nullable: true DataforseoLabsleAppIntersectionLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' description: keyword data for the returned keyword nullable: true intersection_result: type: object additionalProperties: type: object oneOf: - $ref: '#/components/schemas/GooglePlaySearchOrganic' nullable: true description: 'contains SERP data for the returned keyword data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task; depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively' nullable: true DataforseoLabsGoogleAvailableHistoryTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAvailableHistoryResultInfo' nullable: true description: array of objects containing results nullable: true BulkMetricsInfo: type: object properties: etv: type: number description: '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' nullable: true count: type: integer description: total count of organic SERPs that contain the domain format: int64 nullable: true DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAmazonProductRankOverviewLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsAmazonProductRankOverviewLiveRequestInfo: type: object properties: asins: type: array items: type: string description: 'product IDs to compare required field product IDs to receive ranking data for; the maximum number of ASINs you can specify in this array is 1000; you can receive the asin parameter by making a separate request to the Amazon Products endpoint Note: all letters in ASIN code must be specified in uppercase format; example: B01LW2SL7R' location_name: type: string description: 'full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States' nullable: true location_code: type: integer description: 'location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840' nullable: true language_name: type: string description: 'full name of the language required field if don’t 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 example: English' nullable: true language_code: type: string description: 'language code required field if don’t 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 example: en' nullable: true tag: type: string description: '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' nullable: true example: - asins: - B001TJ3HUG - B01LW2SL7R language_name: English location_code: 2840 BulkMetricsBundleInfo: type: object properties: organic: type: object oneOf: - $ref: '#/components/schemas/BulkMetricsInfo' description: traffic data from organic search nullable: true paid: type: object oneOf: - $ref: '#/components/schemas/BulkMetricsInfo' description: traffic data from paid search nullable: true local_pack: type: object oneOf: - $ref: '#/components/schemas/BulkMetricsInfo' description: traffic data from the local pack results in SERP nullable: true featured_snippet: type: object oneOf: - $ref: '#/components/schemas/BulkMetricsInfo' description: traffic data from the featured snippet results in Google SERP nullable: true DataforseoLabsAppleBulkAppMetricsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleBulkAppMetricsLiveTaskInfo' nullable: true description: array of tasks nullable: true BaseDataforseoLabsApiElementItem: type: object properties: type: type: string description: type of element nullable: true se_type: type: string description: search engine type nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank in SERP absolute position among all the elements in SERP' nullable: true position: type: string description: 'the alignment of the element in SERP can take the following values: left, right' nullable: true xpath: type: string description: the XPath of the element nullable: true additionalProperties: false discriminator: propertyName: type mapping: featured_snippet: '#/components/schemas/DataLabsFeaturedSnippetSerpElementItem' local_pack: '#/components/schemas/DataLabsLocalPackSerpElementItem' paid: '#/components/schemas/DataLabsPaidSerpElementItem' organic: '#/components/schemas/DataLabsOrganicSerpElementItem' answer_box: '#/components/schemas/DataLabsAnswerBoxSerpElementItem' carousel: '#/components/schemas/DataLabsCarouselSerpElementItem' multi_carousel: '#/components/schemas/DataLabsMultiCarouselSerpElementItem' google_flights: '#/components/schemas/DataLabsGoogleFlightsSerpElementItem' google_reviews: '#/components/schemas/DataLabsGoogleReviewsSerpElementItem' google_posts: '#/components/schemas/DataLabsGooglePostsSerpElementItem' images: '#/components/schemas/DataLabsImagesSerpElementItem' jobs: '#/components/schemas/DataLabsJobsSerpElementItem' knowledge_graph: '#/components/schemas/DataLabsKnowledgeGraphSerpElementItem' hotels_pack: '#/components/schemas/DataLabsHotelsPackSerpElementItem' map: '#/components/schemas/DataLabsMapSerpElementItem' people_also_ask: '#/components/schemas/DataLabsPeopleAlsoAskSerpElementItem' related_searches: '#/components/schemas/DataLabsRelatedSearchesSerpElementItem' people_also_search: '#/components/schemas/DataLabsPeopleAlsoSearchSerpElementItem' shopping: '#/components/schemas/DataLabsShoppingSerpElementItem' top_stories: '#/components/schemas/DataLabsTopStoriesSerpElementItem' twitter: '#/components/schemas/DataLabsTwitterSerpElementItem' video: '#/components/schemas/DataLabsVideoSerpElementItem' events: '#/components/schemas/DataLabsEventsSerpElementItem' mention_carousel: '#/components/schemas/DataLabsMentionCarouselSerpElementItem' recipes: '#/components/schemas/DataLabsRecipesSerpElementItem' top_sights: '#/components/schemas/DataLabsTopSightsSerpElementItem' scholarly_articles: '#/components/schemas/DataLabsScholarlyArticlesSerpElementItem' popular_products: '#/components/schemas/DataLabsPopularProductsSerpElementItem' podcasts: '#/components/schemas/DataLabsPodcastsSerpElementItem' questions_and_answers: '#/components/schemas/DataLabsQuestionsAndAnswersSerpElementItem' find_results_on: '#/components/schemas/DataLabsFindResultsOnSerpElementItem' stocks_box: '#/components/schemas/DataLabsStocksBoxSerpElementItem' commercial_units: '#/components/schemas/DataLabsCommercialUnitsSerpElementItem' local_services: '#/components/schemas/DataLabsLocalServicesSerpElementItem' google_hotels: '#/components/schemas/DataLabsGoogleHotelsSerpElementItem' math_solver: '#/components/schemas/DataLabsMathSolverSerpElementItem' DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleHistoricalRankOverviewLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true year: type: integer description: year for which the data is provided nullable: true month: type: integer description: month for which the data is provided nullable: true metrics: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: ranking data relevant to the specified domain nullable: true DataforseoLabsAppleAppIntersectionLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleAppIntersectionLiveResultInfo' nullable: true description: array of results nullable: true ClickstreamKeywordInfo: type: object properties: search_volume: type: integer description: current search volume rate of a keyword format: int64 nullable: true last_updated_time: type: string description: 'date and time when backlink data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true gender_distribution: type: object additionalProperties: type: integer format: int64 nullable: true description: 'distribution of estimated clickstream-based metrics by gender learn more about how the metric is calculated in this help center article' nullable: true age_distribution: type: object additionalProperties: type: integer format: int64 nullable: true description: 'distribution of clickstream-based metrics by age learn more about how the metric is calculated in this help center article' nullable: true monthly_searches: type: array items: type: object oneOf: - $ref: '#/components/schemas/MonthlySearchesInfo' nullable: true description: 'monthly searches represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations' nullable: true AmazonMetricsBundleInfo: type: object properties: amazon_serp: type: object oneOf: - $ref: '#/components/schemas/AppMetricsInfo' description: ranking data from Amazon organic SERP nullable: true amazon_paid: type: object oneOf: - $ref: '#/components/schemas/AppMetricsInfo' description: ranking data from Amazon paid SERP nullable: true DataforseoLabsAppleAppCompetitorsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true app_id: type: string description: id of the app in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsleAppCompetitorsLiveItem' nullable: true description: contains data related to the app_id and competitor applications nullable: true DataforseoLabsGoogleRelatedKeywordsLiveRequestInfo: type: object properties: keyword: type: string description: 'keyword required field UTF-8 encoding the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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' nullable: true language_code: type: string description: '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' nullable: true depth: type: integer description: 'keyword search depth optional field default value: 1 number of the returned results depends on the value you set in this field you can specify a level from 0 to 4 estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 8 keywords 2 – 72 keywords 3 – 584 keywords 4 – 4680 keywords' nullable: true include_seed_keyword: type: boolean description: 'include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false' nullable: true include_serp_info: type: boolean description: 'include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true replace_with_core_keyword: type: boolean description: 'return data for core keyword optional field if true, serp_info and related_keywords will be returned for the main keyword in the group that the specified keyword belongs to; if false, serp_info and related_keywords will be returned for the specified keyword (if available); refer to this help center article for more details; default value: false' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ["keyword_data.keyword_info.search_volume",">",0] [["keyword_info.search_volume","in",[0,1000]], "and", ["keyword_data.keyword_info.competition_level","=","LOW"]] [["keyword_data.keyword_info.search_volume",">",100], "and", [["keyword_data.keyword_info.cpc","<",0.5], "or", ["keyword_info.high_top_of_page_bid","<=",0.5]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting type example: ["keyword_data.keyword_info.competition,desc"] default rule: ["keyword_data.keyword_info.search_volume,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - keyword: phone language_name: English location_code: 2840 limit: 3 DataforseoLabsGoogleCompetitorsDomainLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleAppCompetitorsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAppCompetitorsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleTopSearchesLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleTopSearchesLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleRankedKeywordsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveResultInfo' nullable: true description: array of results nullable: true SearchIntentInfo: type: object properties: se_type: type: string description: 'search engine type possible values: google' nullable: true main_intent: type: string description: 'main search intent possible values: informational, navigational, commercial, transactional' nullable: true foreign_intent: type: array items: type: string nullable: true description: 'supplementary search intents possible values: informational, navigational, commercial, transactional' nullable: true last_updated_time: type: string description: 'date and time when the dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true RatingInfo: properties: rating_type: type: string description: 'the type of rating here you can find the following elements: Max5, Percents, CustomMax' nullable: true value: type: number description: the value of the rating format: double nullable: true votes_count: type: integer description: the amount of feedback format: int64 nullable: true rating_max: type: integer description: the maximum value for a rating_type nullable: true DataforseoLabsAppleKeywordsForAppLiveRequestInfo: type: object properties: app_id: type: string description: 'id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320' location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States' nullable: true location_code: type: integer description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en' nullable: true filters: type: array items: type: object nullable: true description: '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: <, <=, >, >=, =, <>, in, not_in example: ["keyword_data.keyword_info.search_volume",">",500] [["keyword_data.keyword_info.search_volume","<>",500],"and",["ranked_serp_element.serp_item.rank_group",">=","10"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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: ["ranked_serp_element.serp_item.rank_group,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: ["ranked_serp_element.serp_item.rank_group,desc","keyword_data.keyword_info.search_volume,asc"] default rule: ["keyword_data.keyword_info.search_volume,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' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - app_id: '686449807' language_name: English location_code: 2840 limit: 10 GooglePlayRankedSerpElementInfo: type: object properties: se_type: type: string description: search engine type nullable: true serp_item: type: object oneOf: - $ref: '#/components/schemas/GooglePlaySearchOrganic' description: 'contains data on the SERP element the list of supported SERP elements can be found below' nullable: true check_url: type: string description: 'direct URL to search engine results you can use it to make sure that we provided accurate results' nullable: true se_results_count: type: integer description: number of search results for the returned keyword nullable: true last_updated_time: type: string description: 'date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true previous_updated_time: type: string description: 'previous to the most recent date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-10-15 12:57:46 +00:00; in this case, will equal null' nullable: true DataforseoLabsGoogleSubdomainsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: domain in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveItem' nullable: true description: contains subdomains and related data nullable: true DataforseoLabsGoogleKeywordsForSiteLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForSiteLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleRankedKeywordsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAmazonRelatedKeywordsLiveRequestInfo: type: object properties: keyword: type: string description: 'keyword required field UTF-8 encoding the keywords should be specified in the lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States' nullable: true location_code: type: integer description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840' nullable: true language_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English' nullable: true language_code: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en' nullable: true depth: type: integer description: 'keyword search depth optional field default value: 1; number of the returned results depends on the value you set in this field; you can specify a level from 0 to 4; estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 6 keywords 2 – 42 keywords 3 – 258 keywords 4 – 1554 keywords' nullable: true include_seed_keyword: type: boolean description: 'include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - keyword: computer mouse language_name: English location_code: 2840 limit: 5 include_seed_keyword: true DataforseoLabsGoogleCompetitorsDomainLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: target domain in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveItem' nullable: true description: contains data related to the target and competitor domains nullable: true DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo: type: object properties: language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveItem' nullable: true description: contains keywords and related keyword difficulty scores nullable: true DataforseoLabsGoogleRankedKeywordsLiveRequestInfo: type: object properties: target: type: string description: 'domain name or page url required field the domain name of the target website or URL of the target webpage; the domain name must be specified without https:// or www.; the webpage URL must be specified with https:// or www. Note: if you specify the webpage URL without https:// or www., the result will be returned for the entire domain rather than the specific page' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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' nullable: true language_code: type: string description: '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' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true item_types: type: array items: type: string description: '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", "ai_overview_reference"] default value: ["organic", "paid"]' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, clickstream_gender_distribution, clickstream_age_distribution, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true load_rank_absolute: type: boolean description: 'return rankings distribution by rank_absolute optional field default value: false if set to true, we will return the field metrics_absolute containing rankings distribution by the rank_absolute parameter that indicates the result’s position among all SERP elements' nullable: true historical_serp_mode: type: string description: 'data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return keywords for which the specified target currently has ranking results in SERP; lost — return keywords for which the specified target had previously had ranking results in SERP, but didn’t have them during the last check; all — return both types of keywords. default value: live' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ["ranked_serp_element.serp_item.rank_group","<=",10] [["ranked_serp_element.serp_item.rank_group","<=",10], "and", ["ranked_serp_element.serp_item.type","<>","paid"]] [["keyword_data.keyword_info.search_volume","<>",0], "and", [["ranked_serp_element.serp_item.type","<>","paid"],"or",["ranked_serp_element.serp_item.is_malicious","=",false]]] if you want to get the keywords a particular webpage ranks for, you can use a target field or filter by the ranked_serp_element.serp_item.relative_url parameter example: ["ranked_serp_element.serp_item.relative_url", "=", "/apis/rank-tracker-api"] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting type example: ["keyword_data.keyword_info.competition,desc"] default rule: ["ranked_serp_element.serp_item.rank_group,asc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]' nullable: true tag: type: string description: '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' nullable: true example: - target: dataforseo.com language_name: English location_name: United States load_rank_absolute: true limit: 3 DataforseoLabsGoogleDomainIntersectionLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsAppleAppCompetitorsLiveRequestInfo: type: object properties: app_id: type: string description: 'id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320' location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States' nullable: true location_code: type: integer description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en' nullable: true filters: type: array items: type: object nullable: true description: '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: <, <=, >, >=, =, <>, in, not_in example: ["intersections",">",500] [["competitor_metrics.app_store_search_organic.pos_1","<>",10],"and",["avg_position",">=","10"]] [[["intersections",">=",50],"and",["competitor_metrics.app_store_search_organic.pos_1","in",[1,5]]], "or", ["sum_position",">=","10000"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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: ["intersections,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: ["intersections,desc","sum_position,asc"] default rule: ["intersections,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' nullable: true limit: type: integer description: 'the maximum number of returned apps optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - app_id: '686449807' language_name: English location_code: 2840 limit: 10 DataforseoLabsGoogleKeywordSuggestionsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAmazonRankedKeywordsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true asin: type: string description: ASIN in a POST array nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveItem' nullable: true description: contains detected Amazon product competitors and related data nullable: true DataforseoLabsGoogleRelatedKeywordsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true seed_keyword: type: string description: keyword in a POST array nullable: true seed_keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' description: 'keyword data for the seed keyword fields in the array are identical to that of keyword_data' nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveItem' nullable: true description: contains keywords and related data nullable: true DataforseoLabsAvailableFiltersResultInfo: type: object properties: related_keywords: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true keyword_suggestions: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true ranked_keywords: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true keyword_ideas: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true serp_competitors: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true relevant_pages: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true subdomains: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true competitors_domain: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true categories_for_domain: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true keywords_for_categories: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true domain_intersection: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true page_intersection: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true top_searches: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true domain_metrics_by_categories: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true keywords_for_site: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true product_competitors: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true product_keyword_intersections: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true app_intersection: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true app_competitors: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true keywords_for_app: type: object additionalProperties: type: object additionalProperties: type: string nullable: true nullable: true nullable: true database_rows_count: type: object additionalProperties: type: string nullable: true nullable: true DataforseoLabsAppleKeywordsForAppLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleBulkTrafficEstimationLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsAmazonRelatedKeywordsLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true seed_keyword: type: string description: keyword in a POST array nullable: true seed_keyword_data: type: object oneOf: - $ref: '#/components/schemas/AmazonKeywordData' description: 'keyword data for the seed keyword fields in the object are identical to that of keyword_data' nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveItem' nullable: true description: contains objects with keywords and related data nullable: true DataforseoLabsAmazonProductRankOverviewLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true asin: type: string description: 'ASIN of the product unique product identifier on Amazon; for more information, refer to this help center guide' nullable: true metrics: type: object oneOf: - $ref: '#/components/schemas/AmazonMetricsBundleInfo' description: average keyword position of the product nullable: true DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleDomainMetricsByCategoriesLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true categories: type: array items: type: integer description: categories in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveItem' nullable: true description: contains historical ranking and traffic data nullable: true DataforseoLabsGoogleBulkAppMetricsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkAppMetricsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleSubdomainsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsAppleAppIntersectionLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleAppIntersectionLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsStatusTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsStatusResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleKeywordIdeasLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordIdeasLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleHistoricalSerpsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveResultInfo' nullable: true description: 'array of results the array includes objects with SERPs for each month within the specified time frame' nullable: true DataforseoLabsGoogleDomainIntersectionLiveRequestInfo: type: object properties: target1: type: string description: 'domain required field the domain name of the first target website the domain should be specified without https:// and www.' target2: type: string description: 'domain required field the domain name of the second target website the domain should be specified without https:// and www.' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en' nullable: true intersections: type: boolean description: 'domain intersections in SERP optional field if you set intersections to true, you will get the keywords for which both target domains specified as target1 and target2 have results within the same SERP; the corresponding SERP elements for both domains will be provided in the results array Note: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million if you specify intersections: false, you will get the keywords for which the domain specified as target1 has results in SERP, and the domain specified as target2 doesn’t; thus, the corresponding SERP elements and other data will be provided for the domain specified as target1only default value: true' nullable: true item_types: type: array items: type: string description: 'search results type indicates type of search results included in the response optional field possible values: ["organic", "paid", "featured_snippet", "local_pack"] default value: ["organic", "paid"]' nullable: true include_serp_info: type: boolean description: 'include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the items array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ["keyword_data.keyword_info.search_volume","in",[100,1000]] [["first_domain_serp_element.etv",">",0],"and",["first_domain_serp_element.description","like","%goat%"]] [["keyword_data.keyword_info.search_volume",">",100], "and", [["first_domain_serp_element.description","like","%goat%"], "or", ["second_domain_serp_element.type","=","organic"]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting parameter example: ["keyword_data.keyword_info.competition,desc"] default rule: ["keyword_data.keyword_info.search_volume,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]' nullable: true tag: type: string description: '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' nullable: true example: - target1: mom.com target2: quora.com language_code: en location_code: 2840 include_serp_info: true limit: 3 DataforseoLabsGoogleCategoriesForDomainLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleAppCompetitorsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleAppCompetitorsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleAppCompetitorsLiveRequestInfo: type: object properties: app_id: type: string description: 'id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger' location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States' nullable: true location_code: type: integer description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en' nullable: true filters: type: array items: type: object nullable: true description: '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: <, <=, >, >=, =, <>, in, not_in example: ["intersections",">",500] [["competitor_metrics.google_play_search_organic.pos_1","<>",10],"and",["avg_position",">=","10"]] [[["intersections",">=",50],"and",["competitor_metrics.google_play_search_organic.pos_1","in",[1,5]]], "or", ["sum_position",">=","10000"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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: ["intersections,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: ["intersections,desc","sum_position,asc"] default rule: ["intersections,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' nullable: true limit: type: integer description: 'the maximum number of returned apps optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - app_id: org.telegram.messenger language_name: English location_code: 2840 limit: 10 DataforseoLabsIdListTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsIdListResultInfo' nullable: true description: array of results nullable: true DataforseoLabsIdListResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsIdListTaskInfo' nullable: true description: array of tasks nullable: true AvgBacklinksInfo: type: object properties: se_type: type: string description: search engine type nullable: true backlinks: type: number description: average number of backlinks nullable: true dofollow: type: number description: average number of dofollow links nullable: true referring_pages: type: number description: average number of referring pages nullable: true referring_domains: type: number description: average number of referring domains nullable: true referring_main_domains: type: number description: average number of referring main domains nullable: true rank: type: number description: 'average rank learn more about the metric and its calculation formula in this help center article' nullable: true main_domain_rank: type: number description: 'average main domain rank learn more about the metric and its calculation formula in this help center article' nullable: true last_updated_time: type: string description: 'date and time when the dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true DataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAppleAppCompetitorsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleAppCompetitorsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleBulkKeywordDifficultyLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveItem' nullable: true description: contains keywords and related keyword difficulty scores nullable: true DataforseoLabsGoogleKeywordsForAppLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsLocationsAndLanguagesTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsLocationsAndLanguagesResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleHistoricalSerpsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleHistoricalRankOverviewLiveRequestInfo: type: object properties: target: type: string description: 'domain required field the domain name of the target website the domain should be specified without https:// and www.' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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' nullable: true language_code: type: string description: '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' nullable: true date_from: type: string description: '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"' nullable: true date_to: type: string description: '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"' nullable: true correlate: type: boolean description: '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' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true include_clickstream_data: type: boolean description: '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' nullable: true tag: type: string description: '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' nullable: true example: - target: dataforseo.com location_code: 2840 language_code: en date_from: '2026-01-15' date_to: '2026-03-15' DataforseoLabsAmazonProductKeywordIntersectionsLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/AmazonKeywordData' description: keyword data for the returned keyword nullable: true intersection_result: type: object additionalProperties: type: object oneOf: - $ref: '#/components/schemas/AmazonInfo' nullable: true description: data on the intersection nullable: true KeywordDataInfo: type: object properties: se_type: type: string description: search engine type nullable: true keyword: type: string description: returned keyword idea nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true keyword_info: type: object oneOf: - $ref: '#/components/schemas/KeywordInfo' description: keyword data for the returned keyword idea nullable: true keyword_info_normalized_with_bing: type: object oneOf: - $ref: '#/components/schemas/KeywordInfoNormalizedWithInfo' description: contains keyword search volume normalized with Bing search volume nullable: true keyword_info_normalized_with_clickstream: type: object oneOf: - $ref: '#/components/schemas/KeywordInfoNormalizedWithInfo' description: contains keyword search volume normalized with clickstream data nullable: true clickstream_keyword_info: type: object oneOf: - $ref: '#/components/schemas/ClickstreamKeywordInfo' description: 'clickstream data for the returned keyword to retrieve results for this field, the parameter include_clickstream_data must be set to true' nullable: true keyword_properties: type: object oneOf: - $ref: '#/components/schemas/KeywordProperties' description: additional information about the keyword nullable: true serp_info: type: object oneOf: - $ref: '#/components/schemas/SerpInfo' description: 'SERP data the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database' nullable: true avg_backlinks_info: type: object oneOf: - $ref: '#/components/schemas/AvgBacklinksInfo' description: 'backlink data for the returned keyword this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 webpages ranking organically for the keyword' nullable: true search_intent_info: type: object oneOf: - $ref: '#/components/schemas/SearchIntentInfo' description: 'search intent info for the returned keyword learn about search intent in this help center article' nullable: true DataforseoLabsErrorsResultInfo: type: object properties: id: type: string description: id of the task nullable: true datetime: type: string description: 'date and time when an error occurred in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true function: type: string description: corresponding API function nullable: true error_code: type: integer description: error code nullable: true error_message: type: string description: 'error message or error URL error message (see full list) or URL that caused an error' nullable: true http_url: type: string description: 'URL that caused an error URL you used for making an API call' nullable: true http_method: type: string description: HTTP method nullable: true http_code: type: integer description: HTTP status code nullable: true http_time: type: number description: time taken by HTTP request nullable: true http_response: type: string description: 'HTTP response server response' nullable: true DataforseoLabsGoogleKeywordIdeasLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true seed_keywords: type: array items: type: string nullable: true description: 'keywords in a POST array keywords are returned with decoded %## (plus character ‘+’ will be decoded to a space character)' nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total number of results relevant to your request in our database format: int64 nullable: true items_count: type: integer description: number of results returned in the items array format: int64 nullable: true offset: type: integer description: current offset value nullable: true offset_token: type: string description: 'offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task' nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' nullable: true description: contains keyword ideas and related data nullable: true History: type: object properties: year: type: integer description: year nullable: true month: type: integer description: month nullable: true keyword_info: type: object oneOf: - $ref: '#/components/schemas/KeywordInfo' description: historical data for the keyword nullable: true DataforseoLabsGoogleDomainMetricsByCategoriesLiveRequestInfo: type: object properties: category_codes: type: array items: type: string description: 'product and service categories required field The maximum number of categories you can specify: 5 you can download the full list of possible categories' first_date: type: string description: 'first date of comparison period required field first date for which domain metrics will be provided; date format: "yyyy-mm-dd"; example: "2021-06-01"; the list available dates is available through the available history endpoint; Note: first_date cannot be greater than today’s date; Also note: the dates specified in first_date and second_date cannot point to the same month of the same year; you can specify the dates in any order: first_date can be greater than second_date and vice versa; minimum date: "2020-10-01"' second_date: type: string description: 'second date of comparison period required field second date for which domain metrics will be provided; date format: "yyyy-mm-dd"; example: "2021-10-01"; the list available dates is available through the available history endpoint; Note: second_date cannot be greater than today’s date; Also note: the dates specified in first_date and second_date cannot point to the same month of the same year; you can specify the dates in any order: second_date can be greater than first_date and vice versa; minimum date: "2020-10-01"' location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; example: United Kingdom' nullable: true location_code: type: integer description: 'unique location identifier 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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; example: English' nullable: true language_code: type: string description: 'unique language identifier 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 languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; example: en' nullable: true item_types: type: array items: type: string description: '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 the organic object, 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"]' nullable: true top_categories_count: type: integer description: 'number of additional domain categories optional field by using this parameter, you can receive domains relevant to additional categories that are not specified in category_codes above; to learn more about the parameter, please refer to this help center article; by default, top_categories_count is equal to the number of categories specified in the category_codes array; Note: top_categories_count cannot be less than the number of categories in the category_codes array; maximum value: 5' format: int64 nullable: true include_subdomains: type: boolean description: 'return subdomains in the API response optional field if false, the API response will contain main_domain only; if true, the API will return main_domain plus its subdomains (if available); default value: true' nullable: true etv_min: type: integer description: 'minimum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv greater than the specified value' nullable: true etv_max: type: integer description: 'maximum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv lesser than the specified value' nullable: true correlate: type: boolean description: '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; Note: we do not recommend setting correlate to false' nullable: true limit: type: integer description: 'the maximum number of domains in the results array optional field default value: 100; maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned domains optional field default value: 0; if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like, not_like; you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters; example: ["metrics_history.202110.organic.pos_1", ">", 15]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: 'results sorting rules optional field you can use the same values as in the filters array to sort the results; default rule: ["organic_etv,desc"]; possible sorting types: asc – results will be sorted in ascending order desc – results will be sorted in descending order; you should use a comma to set up a sorting type; example: ["organic_count,desc"]; note that you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: ["organic_etv,desc","organic_count,asc"]' nullable: true tag: type: string description: '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' nullable: true example: - location_code: 2840 language_code: en category_codes: - 13418 - 11494 first_date: '2026-01-15' second_date: '2026-03-15' limit: 3 DataforseoLabsGoogleAppIntersectionLiveRequestInfo: type: object properties: app_ids: type: object additionalProperties: type: string nullable: true description: 'ids of the target apps required field IDs of the target mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger;; the ids should be specified the following way: "app_ids": { "1": "org.telegram.messenger", "2": "com.zhiliaoapp.musically" } if you specify a single ID here, the API will return results only for one application; the maximum number of app IDs you can specify in this object is 20' nullable: true location_name: type: string description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States' nullable: true location_code: type: integer description: '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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840' nullable: true language_name: type: string description: '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 languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English' nullable: true language_code: type: string description: '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 languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en' nullable: true filters: type: array items: type: object nullable: true description: '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: <, <=, >, >=, =, <>, in, not_in example: ["keyword_data.keyword_info.search_volume",">",500] [["keyword_data.keyword_info.search_volume","<>",500],"and",[intersection_result.382617920.rank_group",">=","10"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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: ["intersection_result.382617920.rank_absolute,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: ["intersection_result.382617920.rank_absolute,desc","keyword_data.keyword_info.search_volume,asc"] default rule: ["keyword_data.keyword_info.search_volume,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' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords' nullable: true tag: type: string description: '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' nullable: true example: - app_ids: '1': org.telegram.messenger '2': com.zhiliaoapp.musically language_name: English location_code: 2840 limit: 10 DataforseoLabsGooglePageIntersectionLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' description: keyword data for the returned keyword nullable: true intersection_result: type: object additionalProperties: type: object oneOf: - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem' nullable: true description: 'contains data on the SERP elements found for the returned keyword data will be provided in separate arrays for each URL you specified in the pages object when setting a task; depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively' nullable: true DataforseoLabsGoogleKeywordIdeasLiveRequestInfo: type: object properties: keywords: type: array items: type: string description: 'keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. The keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: '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' nullable: true location_code: type: integer description: 'unique location identifier 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' nullable: true language_name: type: string description: '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 example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language' nullable: true language_code: type: string description: '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 example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language' nullable: true closely_variants: type: boolean description: 'search mode optional field if set to true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: false' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true include_serp_info: type: boolean description: 'include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true limit: type: integer description: 'the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.' nullable: true offset_token: type: string description: 'offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: ["keyword_info.search_volume",">",0] [["keyword_info.search_volume","in",[0,1000]], "and", ["keyword_info.competition_level","=","LOW"]] [["keyword_info.search_volume",">",100], "and", [["keyword_info.cpc","<",0.5], "or", ["keyword_info.high_top_of_page_bid","<=",0.5]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting parameter default rule: ["relevance,desc"] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint. note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["relevance,desc","keyword_info.search_volume,desc"]' nullable: true tag: type: string description: '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' nullable: true example: - keywords: - phone - watch location_code: 2840 language_code: en include_serp_info: true limit: 3 DataforseoLabsGoogleTopSearchesLiveRequestInfo: type: object properties: location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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' nullable: true language_code: type: string description: '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' nullable: true include_serp_info: type: boolean description: 'include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true filters: type: array items: type: object nullable: true description: '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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like,as well as ilike and not_ilike to match any string of zero or more characters example: ["keyword_info.search_volume",">",0] [["keyword_info.search_volume","in",[0,1000]], "and", ["keyword_info.competition_level","=","LOW"]] [["keyword_info.search_volume",">",100], "and", [["keyword_info.cpc","<",0.5], "or", ["keyword_info.high_top_of_page_bid","<=",0.5]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting type example: ["keyword_info.competition,desc"] default rule: ["keyword_info.search_volume,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["keyword_info.search_volume,desc","keyword_info.cpc,desc"]' nullable: true tag: type: string description: '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' nullable: true limit: type: integer description: 'the maximum number of returned keywords optional field note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request default value: 1000 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.' nullable: true offset_token: type: string description: 'offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center' nullable: true example: - language_name: English location_code: 2840 limit: 3 DataforseoLabsStatusInfo: type: object properties: date_update: type: string description: 'update date of the Google endpoints indicates the last date when the Google endpoints of DataForSEO Labs API were updated; example: 2022-05-16' nullable: true DataforseoLabsGoogleKeywordsForCategoriesLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAppleKeywordsForAppLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleKeywordsForAppLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleDomainRankOverviewLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true metrics: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: ranking data relevant to the specified domain nullable: true DataforseoLabsAmazonBulkSearchVolumeLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveItem' nullable: true description: contains keyword search volume data data nullable: true DataforseoLabsAmazonRankedKeywordsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleKeywordOverviewLiveRequestInfo: type: object properties: keywords: type: array items: type: string description: 'keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: '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' nullable: true location_code: type: integer description: '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' nullable: true language_name: type: string description: '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' nullable: true language_code: type: string description: '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' nullable: true include_serp_info: type: boolean description: 'include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false' nullable: true include_clickstream_data: type: boolean description: 'include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields 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' nullable: true tag: type: string description: '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' nullable: true example: - language_code: en location_code: 2840 include_clickstream_data: true include_serp_info: true keywords: - iphone KeywordProperties: type: object properties: se_type: type: string description: search engine type nullable: true core_keyword: type: string description: 'main keyword in a group contains the main keyword in a group determined by the synonym clustering algorithm if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword' nullable: true synonym_clustering_algorithm: type: string description: 'the algorithm used to identify synonyms possible values: keyword_metrics – indicates the algorithm based on keyword_info parameters text_processing – indicates the text-based algorithm if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword' nullable: true keyword_difficulty: type: integer description: 'difficulty of ranking in the first top-10 organic results for a keyword indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100; calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP; learn more about the metric in this help center guide' nullable: true detected_language: type: string description: 'detected language of the keyword indicates the language of the keyword as identified by our system' nullable: true is_another_language: type: boolean description: 'detected language of the keyword is different from the set language if true, the language set in the request does not match the language determined by our system for a given keyword' nullable: true words_count: type: integer description: 'number of words in the keyword indicates how many words the keyword consists of' format: int64 nullable: true DataforseoLabsLocationsAndLanguagesResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsLocationsAndLanguagesTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleCategoriesForDomainLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true categories: type: array items: type: integer description: 'product and service categories you can download the full list of possible categories' nullable: true metrics: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: ranking data relevant to the specified domain or subdomain nullable: true DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: target domain in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveItem' nullable: true description: contains historical ranking and traffic data nullable: true AmazonRankedSerpElement: type: object properties: se_type: type: string description: search engine type nullable: true serp_item: type: object oneOf: - $ref: '#/components/schemas/AmazonInfo' description: 'contains data on the SERP element the list of supported SERP elements can be found below' nullable: true check_url: type: string description: 'direct URL to Amazon results you can use it to make sure that we provided accurate results' nullable: true serp_item_types: type: array items: type: string nullable: true description: 'direct URL to Amazon results contains types of all search results (items) found in the returned SERP; possible item types: amazon_serp, amazon_paid, editorial_recommendations, top_rated_from_our_brands, related_searches' nullable: true se_results_count: type: integer description: total number of results in Amazon SERP format: int64 nullable: true last_updated_time: type: string description: 'date and time when SERP data was last updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true previous_updated_time: type: string description: 'previous to the most recent update of SERP data in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ” example: 2020-09-12T00:07:43.0733218Z' nullable: true DataforseoLabsGoogleKeywordOverviewLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveItem' nullable: true description: contains keywords and related data nullable: true DataforseoLabsGoogleSerpCompetitorsLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true domain: type: string description: domain name of the detected SERP competitor nullable: true avg_position: type: number description: 'the average position of the domain for the specified keywords the arithmetic mean of values in the keywords_positions array' format: float nullable: true median_position: type: number description: 'the median position of the domain for the specified keywords the median of the values in the keywords_positions array' nullable: true rating: type: number description: 'the margin between the greatest possible and actual keyword positions represents the relative visibility rate of the domain in SERP for the specified keywords calculated as sum(100-keywords_positions)' nullable: true etv: type: number description: 'estimated traffic volume represents the estimated monthly traffic that specified keywords are driving to the website calculated as the sum of the products of the specified keywords’ search volume values and CTR (click-through-rate) rates at certain positions in SERP learn more about how the metric is calculated in this help center article' nullable: true keywords_count: type: integer description: the number of specified keywords the domain has positions for in SERPs format: int64 nullable: true visibility: type: number description: 'SERP visibility rate represents the website visibility rate based on the SERP positions of the specified keywords Keywords with positions in the range from 1 to 10 are assigned the visibility index from 1 to 0.1, respectively Keywords with positions in the range from 11 to 20 have the fixed visibility index of 0.05 keywords with positions from 20 to 100 have the visibility index equal to 0' nullable: true relevant_serp_items: type: integer description: 'the number of SERP elements relevant to the domain represents the number of search results in SERP relevant to the domain for the specified keywords' nullable: true keywords_positions: type: object additionalProperties: type: array items: type: integer nullable: true nullable: true description: 'keyword positions SERP positions the related domain holds in SERP for the specified keywords' nullable: true DataforseoLabsErrorsResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsErrorsTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAmazonProductCompetitorsLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true asin: type: string description: 'ASIN of the product unique product identifier on Amazon; for more information, refer to this help center guide' nullable: true avg_position: type: number description: 'average position of the product in Amazon SERP Note: average position is calculated for intersected keywords only; the value for a given product may differ when combined with different target products' format: float nullable: true sum_position: type: integer description: 'sum of all product positions in Amazon SERP Note: average position is calculated for intersected keywords only; the value for a given product may differ when combined with different target products' nullable: true intersections: type: integer description: number of intersecting keywords nullable: true competitor_metrics: type: object oneOf: - $ref: '#/components/schemas/AmazonMetricsBundleInfo' description: 'metrics for intersecting keywords ranking data relevant to the keywords that the provided asin shares with the target asin; Note: in this object ranking data is provided for the returned competitor’s asin' nullable: true full_metrics: type: object oneOf: - $ref: '#/components/schemas/AmazonMetricsBundleInfo' description: 'metrics for all keywords of the product full overview of ranking data relevant to all keywords that the provided asin is ranking for' nullable: true DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo: type: object properties: targets: type: array items: type: string description: 'target domains and subdomains required field you can specify domains and subdomains in this field; domains and subdomains should be specified without https:// and www.; you can set up to 1000 domains or subdomains' location_name: type: string description: 'full name of the location if you use this field, you don’t have 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' nullable: true location_code: type: integer description: 'location code if you use this field, you don’t have 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' nullable: true language_name: type: string description: 'full name of the language 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' nullable: true language_code: type: string description: 'language code 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' nullable: true date_from: type: string description: 'starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 12 months minimal possible value: 2020-10-01 date format: "yyyy-mm-dd"' nullable: true date_to: type: string description: '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"' nullable: true ignore_synonyms: type: boolean description: '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' nullable: true item_types: type: array items: type: string description: '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; possible values: ["organic", "paid", "featured_snippet", "local_pack"] default value: ["organic", "paid"]' nullable: true tag: type: string description: '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' nullable: true example: - targets: - dataforseo.com - cnn.com - forbes.com location_code: 2840 language_code: en date_from: '2026-01-15' date_to: '2026-03-15' item_types: - organic - paid DataforseoLabsGoogleBulkAppMetricsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleBulkAppMetricsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem' nullable: true description: array of items with relevant traffic estimation data nullable: true DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo: type: object properties: keywords: type: array items: type: string description: 'target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' language_name: type: string description: 'full name of the language required field if don’t 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/google/categories_for_keywords/languages example: English' nullable: true language_code: type: string description: 'language code required field if don’t 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/google/categories_for_keywords/languages example: en' nullable: true tag: type: string description: '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' nullable: true example: - language_code: en keywords: - dentist new york - pizza brooklyn - car dealer los angeles DataforseoLabsAvailableFiltersResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAvailableFiltersTaskInfo' nullable: true nullable: true DataforseoLabsGoogleRelevantPagesLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: target domain in a POST array nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: 'language code in a POST array if there is no data, then the value is null' nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveItem' nullable: true description: relevant pages and related data nullable: true AmazonDeliveryInfo: type: object properties: delivery_message: type: string description: message accompanying the delivery information as posted by the seller nullable: true delivery_date_from: type: string description: the earliest date when the product can be shipped nullable: true delivery_date_to: type: string description: the latest date when the product can be delivered nullable: true fastest_delivery_date_from: type: string description: the earliest date when the product can be delivered with a fast delivery option nullable: true fastest_delivery_date_to: type: string description: the latest date when the product can be delivered with a fast delivery option nullable: true delivery_price: type: object oneOf: - $ref: '#/components/schemas/PriceInfo' description: 'price for the delivery price of the delivery based on the location you specified in the POST request; if free delivery is available, the value is null' nullable: true DataforseoLabsAmazonProductCompetitorsLiveRequestInfo: type: object properties: asin: type: string description: 'product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint' location_name: type: string description: 'full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States' nullable: true location_code: type: integer description: 'location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840' nullable: true language_name: type: string description: 'full name of the language required field if don’t 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 example: English' nullable: true language_code: type: string description: 'language code required field if don’t 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 example: en' nullable: true limit: type: integer description: 'the maximum number of products in the results array optional field default value: 100; maximum value: 1000' nullable: true filters: type: array items: type: object nullable: true description: '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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ["full_metrics.amazon_serp.pos_1",">", 20] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide' nullable: true order_by: type: array items: type: string description: '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 set up a sorting parameter example: ["full_metrics.amazon_serp.pos_1,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["full_metrics.amazon_serp.pos_1,desc","avg_position,desc"] default rule: ["ranked_serp_element.serp_item.rank_group,asc"]' nullable: true offset: type: integer description: 'offset in the results array of returned product competitors optional field default value: 0 if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors' nullable: true tag: type: string description: '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' nullable: true example: - asin: 019005476X location_code: 2840 language_code: en KeywordInfo: type: object properties: se_type: type: string description: search engine type nullable: true last_updated_time: type: string description: 'date and time when keyword data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true competition: type: number description: 'competition represents the relative amount of competition associated with the given keyword. This value is based on Google Ads data and can be between 0 and 1 (inclusive)' nullable: true competition_level: type: string description: 'competition level represents the relative level of competition associated with the given keyword in paid SERP only; possible values: LOW, MEDIUM, HIGH if competition level is unknown, the value is null; learn more about the metric in this help center article' nullable: true cpc: type: number description: 'cost-per-click represents the average cost per click (USD) historically paid for the keyword' nullable: true search_volume: type: integer description: 'average monthly search volume rate represents the (approximate) number of searches for the given keyword idea on google.com' format: int64 nullable: true low_top_of_page_bid: type: number description: 'minimum bid for the ad to be displayed at the top of the first page indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request' nullable: true high_top_of_page_bid: type: number description: 'maximum bid for the ad to be displayed at the top of the first page indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request' nullable: true categories: type: array items: type: integer description: 'product and service categories you can download the full list of possible categories' nullable: true monthly_searches: type: array items: type: object oneOf: - $ref: '#/components/schemas/MonthlySearchesInfo' nullable: true description: 'monthly searches represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations' nullable: true search_volume_trend: type: object oneOf: - $ref: '#/components/schemas/SearchVolumeTrend' description: 'search volume trend changes represents search volume change in percent compared to the previous period' nullable: true DataforseoLabsGoogleDomainRankOverviewLiveResultInfo: type: object properties: se_type: type: string description: search engine type nullable: true target: type: string description: target domain in a POST array nullable: true location_code: type: integer description: location code in a POST array nullable: true language_code: type: string description: language code in a POST array nullable: true total_count: type: integer description: total amount of results in our database relevant to your request format: int64 nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveItem' nullable: true description: contains ranking and traffic data nullable: true BaseResponseInfo: properties: version: type: string description: the current version of the API nullable: true status_code: type: integer description: 'general status code you can find the full list of the response codes here' nullable: true status_message: type: string description: 'general informational message you can find the full list of general informational messages here' nullable: true time: type: string description: total execution time, seconds nullable: true cost: type: number description: total tasks cost, USD format: double nullable: true tasks_count: type: integer description: the number of tasks in the tasks array format: int64 nullable: true tasks_error: type: integer description: the number of tasks in the tasks array returned with an error format: int64 nullable: true KeywordIntentInfo: type: object properties: label: type: string description: 'search intent name possible values: informational, navigational, commercial, transactional' nullable: true probability: type: number description: 'search intent probability 1 indicates the highest probability' nullable: true DataforseoLabsAmazonRankedKeywordsLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' description: keyword data for the returned keyword nullable: true ranked_serp_element: type: object oneOf: - $ref: '#/components/schemas/AmazonRankedSerpElement' description: contains data on the products’s SERP element found for the returned keyword nullable: true DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo: type: object properties: language_name: type: string description: language name nullable: true language_code: type: string description: language code according to ISO 639-1 nullable: true DataforseoLabsGoogleDomainMetricsByCategoriesLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveResultInfo' nullable: true description: array of results nullable: true AmazonKeywordInfo: properties: se_type: type: string description: search engine type nullable: true last_updated_time: type: string description: 'date and time when keyword data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: ''2019-11-15 12:57:46 +00:00''' nullable: true search_volume: type: integer description: 'average monthly search volume rate represents the (approximate) number of searches for the provided keyword idea on Amazon' format: int64 nullable: true DataforseoLabsGoogleSearchIntentLiveRequestInfo: type: object properties: keywords: type: array items: type: string description: 'target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' language_name: type: string description: 'full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports the following languages only: Arabic, ar, Chinese(Traditional), zh-TW, Czech, cs, Danish, da, Dutch, nl, English, en, Finnish, fi, French, fr, German, de, Hebrew, he, Hindi, hi, Italian, it, Japanese, ja, Korean, ko, Malay, ms, Norwegian(Bokmål), nb, Polish, pl, Portuguese, pt, Romanian, ro, Russian, ru, Spanish, es, Swedish, sv, Thai, th, Ukrainian, uk, Vietnamese, vi, Bulgarian, bg, Croatian, hr, Serbian, sr, Slovenian, sl, Bosnian, bs, Greek, el, Hungarian, hu, Slovak, sk, Turkish, tr example: English' nullable: true language_code: type: string description: 'language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these languages only; example: en' nullable: true tag: type: string description: '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' nullable: true example: - language_code: en keywords: - login page - audi a7 - elon musk - milk store new york DataforseoLabsAmazonProductCompetitorsLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsGoogleSubdomainsLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true subdomain: type: string description: returned subdomain nullable: true metrics: type: object additionalProperties: $ref: '#/components/schemas/DataforseoLabsMetricsInfo' description: ranking data relevant to subdomain nullable: true DataforseoLabsGoogleHistoricalKeywordDataLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword: type: string description: 'keyword keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)' nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: language code in a POST array nullable: true history: type: array items: type: object oneOf: - $ref: '#/components/schemas/History' nullable: true description: array of objects with historical data for the keyword nullable: true DataforseoLabsAmazonBulkSearchVolumeLiveRequestInfo: type: object properties: keywords: type: array items: type: string description: 'target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: 'full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the following locations and languages only: Australia – 2036, en Austria – 2040, de Canada – 2124, en Egypt – 2818, ar France – 2250, fr Germany – 2276, de India – 2356, en Italy – 2380, it Mexico – 2484, es Netherlands – 2528, nl Saudi Arabia – 2682, ar Singapore – 2702, en Spain – 2724, es United Arab Emirates – 2784, ar United Kingdom – 2826, en United States – 2840, en example: United States' nullable: true location_code: type: integer description: 'location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports these locations and languages only; example: 2840' nullable: true language_name: type: string description: 'full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these locations and languages only; example: English' nullable: true language_code: type: string description: 'language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these locations and languages only; example: en' nullable: true tag: type: string description: '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' nullable: true example: - keywords: - buy laptop - cheap laptops for sale - purchase laptop location_code: 2840 language_code: en DataforseoLabsGoogleKeywordOverviewLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword: type: string description: 'keyword keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)' nullable: true location_code: type: integer description: 'location code in a POST array if there is no data, then the value is null' nullable: true language_code: type: string description: language code in a POST array nullable: true search_partners: type: boolean description: 'indicates data for Google and partner sites if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search; if false, the results are returned for Google search sites only' nullable: true keyword_info: type: object oneOf: - $ref: '#/components/schemas/KeywordInfo' description: keyword data for the returned keyword nullable: true keyword_info_normalized_with_bing: type: object oneOf: - $ref: '#/components/schemas/KeywordInfoNormalizedWithInfo' description: contains keyword search volume normalized with Bing search volume nullable: true keyword_info_normalized_with_clickstream: type: object oneOf: - $ref: '#/components/schemas/KeywordInfoNormalizedWithInfo' description: contains keyword search volume normalized with clickstream data nullable: true clickstream_keyword_info: type: object oneOf: - $ref: '#/components/schemas/ClickstreamKeywordInfo' description: 'clickstream data for the returned keyword to retrieve results for this field, the parameter include_clickstream_data must be set to true' nullable: true keyword_properties: type: object oneOf: - $ref: '#/components/schemas/KeywordProperties' description: additional information about the keyword nullable: true serp_info: type: object oneOf: - $ref: '#/components/schemas/SerpInfo' description: 'SERP data the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database' nullable: true avg_backlinks_info: type: object oneOf: - $ref: '#/components/schemas/AvgBacklinksInfo' description: 'backlink data for the returned keyword this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword' nullable: true search_intent_info: type: object oneOf: - $ref: '#/components/schemas/SearchIntentInfo' description: 'search intent info for the returned keyword learn about search intent in this help center article' nullable: true DataforseoLabsGoogleDomainIntersectionLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsAmazonProductCompetitorsLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveResultInfo' nullable: true description: array of results nullable: true DataforseoLabsAmazonBulkSearchVolumeLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword: type: string description: keyword in a POST array nullable: true search_volume: type: integer description: 'average monthly search volume rate represents the (approximate) number of searches for the returned keyword on Amazon' format: int64 nullable: true DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo' nullable: true description: array of tasks nullable: true DataforseoLabsMetricsInfo: type: object properties: pos_1: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #1' nullable: true pos_2_3: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #2-3' nullable: true pos_4_10: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #4-10' nullable: true pos_11_20: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #11-20' nullable: true pos_21_30: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #21-30' nullable: true pos_31_40: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #31-40' nullable: true pos_41_50: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #41-50' nullable: true pos_51_60: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #51-60' nullable: true pos_61_70: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #61-70' nullable: true pos_71_80: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #71-80' nullable: true pos_81_90: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #81-90' nullable: true pos_91_100: type: integer description: 'number of organic SERPs where the domain or subdomain ranks #91-100' nullable: true etv: type: number description: 'estimated traffic volume estimated organic monthly traffic to the domain or subdomain calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for learn more about how the metric is calculated in this help center article' nullable: true count: type: integer description: total count of organic SERPs that contain the domain or subdomain format: int64 nullable: true estimated_paid_traffic_cost: type: number description: '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 the domain or subdomain 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' nullable: true is_new: type: integer description: 'number of new ranked elements indicates how many new ranked elements were found for the indicated target' nullable: true is_up: type: integer description: 'rank went up indicates how many ranked elements of the indicated target went up' nullable: true is_down: type: integer description: 'rank went down indicates how many ranked elements of the indicated target went down' nullable: true is_lost: type: integer description: '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' nullable: true clickstream_etv: type: number description: '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' format: double nullable: true clickstream_gender_distribution: type: object additionalProperties: type: integer format: int64 nullable: true description: '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' nullable: true clickstream_age_distribution: type: object additionalProperties: type: integer format: int64 nullable: true description: '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' nullable: true DataforseoLabsGoogleKeywordsForAppLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' description: keyword data for the returned keyword nullable: true ranked_serp_element: type: object oneOf: - $ref: '#/components/schemas/GooglePlayRankedSerpElementInfo' description: contains data on the domain’s SERP element found for the returned keyword nullable: true DataforseoLabsGoogleDomainIntersectionLiveItem: type: object properties: se_type: type: string description: search engine type nullable: true keyword_data: type: object oneOf: - $ref: '#/components/schemas/KeywordDataInfo' description: keyword data for the returned keyword nullable: true first_domain_serp_element: type: object oneOf: - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem' description: 'contains data on the first domain’s SERP element found for the returned keyword the list of supported SERP elements can be found below' nullable: true second_domain_serp_element: type: object oneOf: - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem' description: 'contains data on the second domain’s SERP element found for the returned keyword the list of supported SERP elements can be found below' nullable: true securitySchemes: basicAuth: type: http scheme: basic