{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "DataForSEO Keywords Data API Schemas", "definitions": { "KeywordsDataBingKeywordPerformanceTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordPerformanceTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BaseResponseInfo": { "properties": { "version": { "type": "string", "description": "the current version of the API", "nullable": true }, "status_code": { "type": "integer", "description": "general status code\nyou can find the full list of the response codes here", "nullable": true }, "status_message": { "type": "string", "description": "general informational message\nyou 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 } } }, "KeywordsDataBingKeywordPerformanceTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordPerformanceTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordPerformanceTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "year": { "type": "integer", "description": "indicates the year for which the data is provided for\nexample:\n2020", "nullable": true }, "month": { "type": "integer", "description": "indicates the month for which the data is provided for\nexample:\n10", "nullable": true }, "keyword_kpi": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordKpi" } ], "description": "object containing keyword metrics\nif there is no data, then the value is\u00a0null", "nullable": true } } }, "KeywordKpi": { "type": "object", "properties": { "desktop": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordKpiItemInfo" } ], "nullable": true }, "description": "keyword data aggregated for desktop devices\nif there is no data, then the value is\u00a0null", "nullable": true }, "mobile": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordKpiItemInfo" } ], "nullable": true }, "description": "keyword data aggregated for mobile devices\nif there is no data, then the value is\u00a0null", "nullable": true }, "tablet": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordKpiItemInfo" } ], "nullable": true }, "description": "keyword data aggregated for tablet devices\nif there is no data, then the value is\u00a0null", "nullable": true } } }, "KeywordKpiItemInfo": { "type": "object", "properties": { "ad_position": { "type": "string", "description": "represents the position of the relevant ad in SERP\ncan take the following values:\nFirstPage1: The first ad to appear on the right side of the first search results page\nFirstPage2: The second ad to appear on the right side of the first search results page\nFirstPage3: The third ad to appear on the right side of the first search results page\nFirstPage4: The fourth ad to appear on the right side of the first search results page\nFirstPage5: The fifth ad to appear on the right side of the first search results page\nFirstPage6: The sixth ad to appear on the right side of the first search results page\nFirstPage7: The seventh ad to appear on the right side of the first search results page\nFirstPage8: The eighth ad to appear on the right side of the first search results page\nFirstPage9: The ninth ad to appear on the right side of the first search results page\nFirstPage10: The tenth ad to appear on the right side of the first search results page\nMainLine1: The first ad to appear at the top of the search results page\nMainLine2: The second ad to appear at the top of the search results page\nMainLine3: The third ad to appear at the top of the search results page\nMainLine4: The fourth ad to appear at the top of the search results page", "nullable": true }, "clicks": { "type": "integer", "description": "ad clicks\nthe number of clicks that the keyword and match type generated during the last month", "nullable": true }, "impressions": { "type": "integer", "description": "ad impressions\nthe number of impressions that the keyword and match type generated during the last month", "nullable": true }, "average_cpc": { "type": "number", "description": "average cost per click, USD\ncalculated by dividing the cost of all clicks by the number of clicks", "format": "double", "nullable": true }, "ctr": { "type": "number", "description": "click-through rate as a percentage\ncalculated by dividing the number of clicks by the number of impressions and multiplying the result by 100", "format": "double", "nullable": true }, "total_cost": { "type": "number", "description": "total cost of an ad, USD\nthe cost of using the specified keyword and match type during the last month", "format": "int64", "nullable": true }, "average_bid": { "type": "number", "description": "average bid of the keyword", "format": "double", "nullable": true } } }, "BaseResponseTaskInfo": { "properties": { "id": { "type": "string", "description": "task identifier\nunique task identifier in our system in the UUID format", "nullable": true }, "status_code": { "type": "integer", "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here", "nullable": true }, "status_message": { "type": "string", "description": "informational message of the task\nyou 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 } } }, "KeywordsDataBingAudienceEstimationTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true } } }, "KeywordsDataDataforseoTrendsExploreLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsExploreLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsExploreLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsExploreLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsExploreLiveResultInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "keywords in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "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/DataforseoTrendsDataforseoTrendsGraphElementItem" } ], "nullable": true }, "description": "contains keyword popularity and related data", "nullable": true } } }, "DataforseoTrendsDataforseoTrendsGraphElementItem": { "type": "object", "allOf": [ { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BaseKeywordDataDataforseoTrendsItem" } ], "nullable": true }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DataforseoTrendsGraphDataTrendsGraphDataInfo" } ], "nullable": true }, "description": "DataForSEO Trends data for the specified parameters", "nullable": true }, "averages": { "type": "array", "items": { "type": "integer", "nullable": true }, "description": "keyword popularity values averaged over the whole time range", "nullable": true } } } ] }, "BaseKeywordDataDataforseoTrendsItem": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "position": { "type": "integer", "description": "the alignment of the element\ncan take the following values: 1, 2, 3, 4, etc.", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "relevant keywords\nthe data included in the dataforseo_trends_graph element is based on the keywords listed in this array", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "dataforseo_trends_graph": "#/components/schemas/DataforseoTrendsDataforseoTrendsGraphElementItem", "subregion_interests": "#/components/schemas/DataforseoTrendsSubregionInterestsElementItem", "demography": "#/components/schemas/DataforseoTrendsDemographyElementItem" } } }, "DataforseoTrendsGraphDataTrendsGraphDataInfo": { "type": "object", "properties": { "date_from": { "type": "string", "description": "start date of the corresponding time range\nin the UTC format: \u201cyyyy-mm-dd\u201d", "nullable": true }, "date_to": { "type": "string", "description": "end date of the corresponding time range\nin the UTC format: \u201cyyyy-mm-dd\u201d", "nullable": true }, "timestamp": { "type": "integer", "description": "a point in time in the Unix time format", "nullable": true }, "values": { "type": "array", "items": { "type": "integer", "nullable": true }, "description": "relative keyword popularity rate at a specific timestamp\nrepresents the keyword popularity rate over the given time range\nif you specify more than one keyword, the values will be averaged to the highest value across all specified keywords\na value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term", "nullable": true } } }, "KeywordsDataBingKeywordsForSiteTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForSiteTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForSiteTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForSiteTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForSiteTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data the value is null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data the value is null", "nullable": true }, "search_partners": { "type": "boolean", "description": "indicates whether data from partner networks included in the response", "nullable": true }, "device": { "type": "string", "description": "device type in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "competition": { "type": "number", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.\nPossible values: 0.1, 0.5,0.9 \n0.1 \u2013 low competition,\n0.5 \u2013 medium competition,\n0.9 \u2013 high competition;\nif there is no data the value is null", "nullable": true }, "cpc": { "type": "number", "description": "cost-per-click\nrepresents the average cost per click (USD) historically paid for the keyword.\nif there is no data the value is null", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nrepresents the (approximate) number of searches for the given keyword idea on Bing search engine depending on the user\u2019s targeting\nif there is no data then the value is\u00a0null", "format": "int64", "nullable": true }, "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "product and service categories\nlegacy field, the value will always be null", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations\nsearch volume is rounded to the closest decimal values\nif there is no data the value is null", "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 } } }, "KeywordsDataBingKeywordPerformanceLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordPerformanceLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordPerformanceLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordPerformanceLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordPerformanceLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "year": { "type": "integer", "description": "indicates the year for which the data is provided for\nexample:\n2020", "nullable": true }, "month": { "type": "integer", "description": "indicates the month for which the data is provided for\nexample:\n10", "nullable": true }, "keyword_kpi": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordKpi" } ], "description": "object containing keyword metrics\nif there is no data, then the value is\u00a0null", "nullable": true } } }, "KeywordsDataBingKeywordPerformanceTaskPostRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 80\nThe maximum number of words for each keyword phrase: 10\nthe specified keywords will be converted to lowercase, data will be provided in a separate array\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "device": { "type": "string", "description": "device type\noptional field\nspecify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all\ndefault value: all", "nullable": true }, "match": { "type": "string", "description": "keywords match type\noptional field\ncan take the following values:\naggregate returns data across all match types;\nbroad returns data for all user queries containing the specified keyword with varying word order;\nphrase returns data for all user queries containing the specified keyword with identical word order;\nexact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default", "nullable": true }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages\nexample:\n\"United States\"", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nyou can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages\nexample:\n\"en\"", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "language_code": "en", "keywords": [ "dataforseo", "seo", "ranking" ] } ] }, "KeywordsDataBingKeywordPerformanceLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 80\nThe maximum number of words for each keyword phrase: 10\nthe specified keywords will be converted to lowercase, data will be provided in a separate array\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "device": { "type": "string", "description": "device type\noptional field\nspecify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all\ndefault value: all", "nullable": true }, "match": { "type": "string", "description": "keywords match type\noptional field\ncan take the following values:\naggregate returns data across all match types;\nbroad returns data for all user queries containing the specified keyword with varying word order;\nphrase returns data for all user queries containing the specified keyword with identical word order;\nexact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default", "nullable": true }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages\nexample:\n\"United States\"", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nyou can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages\nexample:\n\"en\"", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "language_code": "en", "keywords": [ "dataforseo", "seo", "ranking" ] } ] }, "KeywordsDataGoogleTrendsExploreTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsExploreTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsExploreTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsExploreTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsExploreTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true } } }, "KeywordsDataGoogleAdsSearchVolumeTaskPostRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 80\nThe maximum number of words for each keyword phrase: 10\nthe keywords you specify will be converted to a lowercase format\nNote #1: Google Ads may return no data for certain groups of keywords;\nNote #2: Google Ads provides combined search volume values for groups of similar keywords\nto obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;\nNote #3: Google Ads doesn\u2019t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can\u2019t use them when setting a task;\nto learn more about which symbols and characters can be used, please refer to this article\nlearn 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 search engine location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_coordinate;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_code;\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format;\nthe data will be provided for the country the specified coordinates belong to;\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nen", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;\ndefault value: false \u2013 results are returned for Google search sites", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\ndate format: \"yyyy-mm-dd\"\nminimal value: 4 years from the current date\nby default, data is returned for the past 12 months;\nNote: the indicated date cannot be greater than that specified in date_to and/or yesterday\u2019s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;\nif Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nNote: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;\nif you don\u2019t specify this field, yesterday\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2022-11-30\"", "nullable": true }, "include_adult_keywords": { "type": "boolean", "description": "include keywords associated with adult content\noptional field\nif set to\u00a0true, adult keywords will be included in the response\ndefault value:\u00a0false\nnote\u00a0that the API may return no data for such keywords due to\u00a0Google Ads restrictions", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nuse these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order\ndefault value: relevance", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special character in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special character in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data array of the response", "nullable": true } }, "example": [ { "location_name": "United States", "keywords": [ "buy laptop", "cheap laptops for sale", "purchase laptop" ] } ] }, "KeywordsDataBingSearchVolumeTaskPostRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 100\nthe specified keywords will be converted to lowercase, data will be provided in a separate array\nlearn 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 search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nsupported languages:\nEnglish, French, German", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nsupported languages:\nen, fr, de", "nullable": true }, "device": { "type": "string", "description": "device type\noptional field\nspecify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet\ndefault value: all", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order\ndefault value: relevance", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nif you don\u2019t specify this field, data will be provided for the last 12 months\nminimal value: 24 months from today\u2019s date\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-01-01\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, data will be provided for the last 12 months;\nminimum value: two years back from today\u2019s date;\nmaximum value: one month from today\u2019s date;\nnote: we do not recommend using a custom time range for the past year\u2019s dates;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-03-15\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "search_partners": { "type": "boolean", "description": "Bing search partners type\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.\ndefault value: false \u2013 results are returned for Bing, AOL, and Yahoo search networks", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_name": "United States", "language_name": "English", "keywords": [ "average page rpm adsense", "adsense blank ads how long", "leads and prospects" ] } ] }, "KeywordsDataGoogleTrendsExploreTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsExploreTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsExploreTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsExploreTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsExploreTaskGetResultInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "keywords in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to the Google Trends results\nyou 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\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "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/BaseKeywordDataGoogleTrendsItem" } ], "nullable": true }, "description": "items on the Google Trends page", "nullable": true } } }, "BaseKeywordDataGoogleTrendsItem": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "position": { "type": "integer", "description": "the alignment of the element in Google Trends\ncan take the following values: 1, 2, 3, 4, etc.", "nullable": true }, "title": { "type": "string", "description": "title of the element in Google Trends", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "relevant keywords\nthe data included in the google_trends_graph element is based on the keywords listed in this array", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "google_trends_graph": "#/components/schemas/GoogleTrendsGoogleTrendsGraphElementItem", "google_trends_map": "#/components/schemas/GoogleTrendsGoogleTrendsMapElementItem", "google_trends_queries_list": "#/components/schemas/GoogleTrendsGoogleTrendsQueriesListElementItem", "google_trends_topics_list": "#/components/schemas/GoogleTrendsGoogleTrendsTopicsListElementItem" } } }, "KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true } } }, "KeywordsDataDataforseoTrendsExploreLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nthe maximum number of keywords you can specify: 5\nlearn 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 search engine location\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nnote that the data will be provided for the country the specified location_name belongs to;\nexample:\nUnited Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nnote that the data will be provided for the country the specified location_code belongs to;\nexample:\n2840", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nif you don\u2019t specify this field, the current day and month of the preceding year will be used by default\nminimal value for the web type: 2004-01-01\nminimal value for other types: 2008-01-01\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, the today\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "time_range": { "type": "string", "description": "preset time ranges\noptional field\nif you specify date_from or date_to parameters, this field will be ignored when setting a task\npossible values for all type parameters:\npast_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "keywords": [ "iphone 14", "samsung s23" ], "location_code": 2840 } ] }, "KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsSearchVolumeLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsSearchVolumeLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character)", "nullable": true }, "spell": { "type": "string", "description": "correct spelling of the keyword\nNote:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;\nwe use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "search_partners": { "type": "boolean", "description": "indicates whether data from partner networks included in the response", "nullable": true }, "competition": { "type": "string", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only;\nthis value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW;\nif there is no data the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "competition_index": { "type": "integer", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only;\nthis value is based on Google Ads data and can be between 0 and 100 (inclusive);\nif there is no data the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate", "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\nindicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);\nthe 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\nindicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);\nthe value may differ depending on the location specified in a POST request", "nullable": true }, "cpc": { "type": "number", "description": "cost per click\nindicates the amount paid (USD) for each click on the ad displayed for a given keyword", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months by default), targeted to the specified geographic locations;\nif there is no data then the value is\u00a0null", "nullable": true } } }, "KeywordsDataGoogleAdsStatusResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsStatusTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsStatusTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsStatusResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsStatusResultInfo": { "type": "object", "properties": { "actual_data": { "type": "boolean", "description": "indicates whether Google updated keyword data for the previous month\ngenerally, Google updates keyword data in the middle of the month\nif the value is true, Google currently provides up-to-date data for the previous month\nif the value is false, we are not able to provide data for the previous month", "nullable": true }, "date_update": { "type": "string", "description": "date of the latest update of Google Ads data\nindicates the latest date when Google updated search volume, CPC, and other keyword metrics\nexample:\n2020-05-15", "nullable": true }, "last_year_in_monthly_searches": { "type": "integer", "description": "the latest year for which search volume data is available", "nullable": true }, "last_month_in_monthly_searches": { "type": "integer", "description": "the latest month for which search volume data is available", "nullable": true } } }, "KeywordsDataGoogleAdsKeywordsForSiteLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForSiteLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForSiteLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "spell": { "type": "string", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, the value is\u00a0null", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\nthe value you specified when setting the task\nif true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;\nif false, the results are returned for Google search sites only", "nullable": true }, "competition": { "type": "string", "description": "competition\nrepresents the relative level of competition associated with the given keyword in paid SERP only\npossible values: LOW, MEDIUM, HIGH\nif competition level is unknown, the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "competition_index": { "type": "integer", "description": "competition index\nthe competition index for the query indicating how competitive ad placement is for the keyword\ncan take values from 0 to 100\nthe level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available\nif not enough data is available, the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nrepresents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user\u2019s targeting\nif there is no data, the value is null", "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\nindicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)\nthe 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\nindicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)\nthe value may differ depending on the location specified in a POST request", "nullable": true }, "cpc": { "type": "number", "description": "cost per click\nindicates the amount paid (USD) for each click on the ad displayed for a given keyword", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations\nif there is no data, the value is null", "nullable": true } } }, "KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForSiteTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true } } }, "KeywordsDataBingSearchVolumeLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "search_partners": { "type": "boolean", "description": "indicates whether data from partner networks included in the response", "nullable": true }, "device": { "type": "string", "description": "device type in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "competition": { "type": "number", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.\nPossible values: 0.1, 0.5,0.90.1 \u2013 low competition,\n0.5 \u2013 medium competition,\n0.9 \u2013 high competition;\nif there is no data the value is null", "nullable": true }, "cpc": { "type": "number", "description": "cost-per-click\nrepresents the average cost per click (USD) historically paid for the keyword.\nif there is no data then the value is\u00a0null", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nsearch volume is rounded to the nearest tens", "format": "int64", "nullable": true }, "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "product and service categories\nour API doesn\u2019t return categories for this endpoint: the parameter will always equal null", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations\nif there is no data then the value is\u00a0null", "nullable": true } } }, "KeywordsDataBingSearchVolumeHistoryLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 100\nthe specified keywords will be converted to lowercase, data will be provided in a separate array\nlearn 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 search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages", "nullable": true }, "device": { "type": "array", "items": { "type": "string" }, "description": "device types\noptional field\nspecify this field if you want to get the data for a particular device types\npossible values: mobile, desktop, tablet, non_smartphones\ndefault value: [\"mobile\", \"desktop\", \"tablet\", \"non_smartphones\"]", "nullable": true }, "period": { "type": "string", "description": "aggregates the returned data to a certain time period\noptional field\nspecify this field if you want to get the data in monthly, weekly or daily format\npossible values: monthly, weekly, daily\nmonthly \u2013 returns data up to past 24 months\nweekly \u2013 returns data up to past 15 weeks\ndaily \u2013 returns data up to past 45 days\ndefault value: monthly", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nminimum value: 24 months back from today\u2019s date\nmaximum value: one day from today\u2019s date\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-01-01\"\nNote: we do not recommend using a custom time range\nNote 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months\nif you specify the period parameter:\nwith value weekly, you will get results for the past 15 weeks\nwith value daily, you will get results for the past 45 days", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nminimum value: two years back from today\u2019s date;\nmaximum value: one day from today\u2019s date;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-03-15\"\nNote: we do not recommend using a custom time range\nNote 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months\nif you specify the period parameter:\nwith value weekly, you will get results for the past 15 weeks\nwith value daily, you will get results for the past 45 days", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "language_code": "en", "keywords": [ "10 minute timer" ] } ] }, "KeywordsDataBingAudienceEstimationLiveRequestInfo": { "type": "object", "properties": { "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude,radius (in km)\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n29.6821525,-82.4098881,100", "nullable": true }, "age": { "type": "array", "items": { "type": "string" }, "description": "selection of age ranges for targeting\npossible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve", "nullable": true }, "bid": { "type": "number", "description": "desired bid setting value in USD\nmaximum value: 1000", "nullable": true }, "daily_budget": { "type": "number", "description": "daily campaign budget value in USD\nmaximum value: 10000", "nullable": true }, "gender": { "type": "array", "items": { "type": "string" }, "description": "gender to target\npossible values: male, female, unknown", "nullable": true }, "industry": { "type": "array", "items": { "type": "string" }, "description": "industry of LinkedIn profile targeting\nif you use this field, you can receive the list of available industry names with industry_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries\nexample: 806301758", "nullable": true }, "job_function": { "type": "array", "items": { "type": "string" }, "description": "job function of LinkedIn profile targeting\nif you use this field, you can receive the list of available job function names with job_function_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions\nexample: 806300451", "nullable": true } }, "example": [ { "location_coordinate": "29.6821525,-82.4098881,100", "age": [ "twenty_five_to_thirty_four", "eighteen_to_twenty_four", "unknown" ], "bid": 1, "daily_budget": 24, "gender": [ "male" ], "industry": [ 806303407, 806301758 ], "job_function": [ 806298607 ] } ] }, "KeywordsDataGoogleTrendsExploreLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nthe maximum number of keywords you can specify: 5\nthe maximum number of characters you can specify in a keyword: 100\nthe minimum number of characters must be greater than 1\ncomma characters (,) in the specified keywords will be unset and ignored\nNote: keywords cannot consist of a combination of the following characters: < > | \\ \" - + = ~ ! : * ( ) [ ] { }\nNote: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword\nlearn 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 search engine location\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_code\nyou can use this field as an array to set several locations, each corresponding to a specific keyword \u2013 learn more;\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations\nexample:\nUnited Kingdom", "nullable": true }, "location_code": { "type": "string", "description": "search engine location code\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_name\nyou can use this field as an array to set several locations, each corresponding to a specific keyword \u2013 learn more;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations\nexample:\n2840", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\ndefault value: English\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\ndefault value: en\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages\nexample:\nen", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "category_code": { "type": "integer", "description": "google trends search category\noptional field\nif you don\u2019t specify this field, the 0 value will be applied by default and the search will be carried out across all available categories\nyou can receive the list of available categories with their category_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google_trends/categories", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nif you don\u2019t specify this field, the current day and month of the preceding year will be used by default\nminimal value for the web type: 2004-01-01\nminimal value for other types: 2008-01-01\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, the today\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "time_range": { "type": "string", "description": "preset time ranges\noptional field\nif you specify date_from or date_to parameters, this field will be ignored when setting a task\npossible values for all type parameters:\npast_hour, past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years\npossible values for web only:\n2004_present\npossible values for news, youtube, images, froogle:\n2008_present", "nullable": true }, "item_types": { "type": "array", "items": { "type": "string" }, "description": "types of items returned\noptional field\nto speed up the execution of the request, specify one item at a time;\npossible values:\n\"google_trends_graph\", \"google_trends_map\", \"google_trends_topics_list\",\"google_trends_queries_list\"\ndefault value:\n\"google_trends_graph\"\nNote: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword in the keywords field", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_name": "United States", "date_from": "2026-01-15", "date_to": "2026-03-15", "type": "youtube", "category_code": 3, "keywords": [ "rugby", "cricket" ] } ] }, "KeywordsDataBingKeywordsForSiteTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForSiteTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForSiteTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForSiteTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForSiteTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true }, "function": { "type": "string", "nullable": true } } }, "KeywordsDataDataforseoTrendsSubregionInterestsLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nthe maximum number of keywords you can specify: 5\navoid symbols and special characters (e.g., UTF symbols, emojis);\nspecifying non-Latin characters, you\u2019ll get data for the countries where they are used\nlearn 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 search engine location\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nnote that the data will be provided for the country the specified location_name belongs to;\nexample:\nUnited Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nnote that the data will be provided for the country the specified location_code belongs to;\nexample:\n2840", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nif you don\u2019t specify this field, the current day and month of the preceding year will be used by default\nminimal value for the web type: 2004-01-01\nminimal value for other types: 2008-01-01\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, the today\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "time_range": { "type": "string", "description": "preset time ranges\noptional field\nif you specify date_from or date_to parameters, this field will be ignored when setting a task\npossible values for all type parameters:\npast_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "keywords": [ "rugby", "cricket" ], "date_from": "2026-01-15", "date_to": "2026-03-15", "type": "web", "location_name": "United States" } ] }, "KeywordsDataGoogleTrendsLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsLocationsResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_code_parent": { "type": "integer", "description": "the code of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_code_parent\": 20044\nwhere location_code_parent corresponds to:\n\"location_code\": 20044,\n\"location_name\": \"Lower Austria,Austria\"", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type\npossible values according to Google\u2019s target types", "nullable": true }, "geo_id": { "type": "string", "description": "google trends location identifier\nyou can use this field for matching obtained results with the location_code parameter specified in the request", "nullable": true } } }, "KeywordsDataGoogleAdsKeywordsForSiteTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForSiteTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForSiteTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "spell": { "type": "string", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, the value is\u00a0null", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\nthe value you specified when setting the task\nif true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;\nif false, the results are returned for Google search sites only", "nullable": true }, "competition": { "type": "string", "description": "competition\nrepresents the relative level of competition associated with the given keyword in paid SERP only\npossible values: LOW, MEDIUM, HIGH\nif competition level is unknown, the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "competition_index": { "type": "integer", "description": "competition index\nthe competition index for the query indicating how competitive ad placement is for the keyword\ncan take values from 0 to 100\nthe level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available\nif not enough data is available, the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nrepresents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user\u2019s targeting\nif there is no data, the value is null", "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\nindicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)\nthe 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\nindicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)\nthe value may differ depending on the location specified in a POST request", "nullable": true }, "cpc": { "type": "number", "description": "cost per click\nindicates the amount paid (USD) for each click on the ad displayed for a given keyword", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations\nif there is no data, the value is null", "nullable": true } } }, "KeywordsDataGoogleAdsKeywordsForSiteLiveRequestInfo": { "type": "object", "properties": { "target": { "type": "string", "description": "domain or page\nrequired field\nthe domain name of the target website or the url of the target page;\nnote: to obtain keywords for the target website, use the target_type parameter" }, "target_type": { "type": "string", "description": "search keywords for site or for url\noptional field\npossible values: site, page;\ndefault value: page;\nif set to site, keywords will be provided for the entire site;\nif set to page, keywords will be provided for the specified webpage", "nullable": true }, "location_name": { "type": "string", "description": "full name of search engine location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_coordinate;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_code;\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format;\nthe data will be provided for the country the specified coordinates belong to;\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nen", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;\ndefault value: false \u2013 results are returned for Google search sites", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\ndate format: \"yyyy-mm-dd\"\nminimal value: 4 years from the current date\nby default, data is returned for the past 12 months;\nNote: the indicated date cannot be greater than that specified in date_to and/or yesterday\u2019s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;\nif Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nNote: the indicated date cannot be greater than yesterday\u2019s date;\nif you don\u2019t specify this field, yesterday\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2022-11-30\"", "nullable": true }, "include_adult_keywords": { "type": "boolean", "description": "include keywords associated with adult content\noptional field\nif set to true, adult keywords will be included in the response\ndefault value: false\nnote that the API may return no data for such keywords due to Google Ads restrictions", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order\ndefault value: relevance", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "target": "dataforseo.com" } ] }, "KeywordsDataBingAudienceEstimationTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true } } }, "KeywordsDataBingSearchVolumeTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword 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 }, "search_partners": { "type": "boolean", "description": "indicates whether data from partner networks included in the response", "nullable": true }, "device": { "type": "string", "description": "device type in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "competition": { "type": "number", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.\nPossible values: 0.1, 0.5,0.9 \n0.1 \u2013 low competition,\n0.5 \u2013 medium competition,\n0.9 \u2013 high competition;\nif there is no data the value is null", "nullable": true }, "cpc": { "type": "number", "description": "cost-per-click\nrepresents the average cost per click (USD) historically paid for the keyword.\nif there is no data then the value is\u00a0null", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nsearch volume is rounded to the nearest tens", "format": "int64", "nullable": true }, "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "product and service categories\nour API doesn\u2019t return categories for this endpoint: the parameter will always equal null", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations\nif there is no data then the value is\u00a0null", "nullable": true } } }, "KeywordsDataBingKeywordsForKeywordsLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForKeywordsLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForKeywordsLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForKeywordsLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForKeywordsLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "search_partners": { "type": "boolean", "description": "indicates whether data from partner networks is included in the response", "nullable": true }, "device": { "type": "string", "description": "device type\nindicates for what device type the data is provided;\npossible values: all, mobile, desktop, tablet", "nullable": true }, "competition": { "type": "number", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.\nPossible values: 0.1, 0.5,0.90.1 \u2013 low competition,\n0.5 \u2013 medium competition,\n0.9 \u2013 high competition;\nif there is no data the value is null", "nullable": true }, "cpc": { "type": "number", "description": "cost-per-click\nrepresents the average cost per click (USD) historically paid for the keyword.\nif there is no data, then the value is\u00a0null", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nrepresents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user\u2019s targetingsearch volume is rounded to the closest decimal values\nif there is no data, then the value is\u00a0null", "format": "int64", "nullable": true }, "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "product and service categories\nlegacy field, the value will always be null", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.\nif there is no data, then the value is\u00a0null", "nullable": true } } }, "KeywordsDataBingKeywordsForKeywordsTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForKeywordsTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForKeywordsTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForKeywordsTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForKeywordsTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true }, "function": { "type": "string", "description": "type of the task", "nullable": true } } }, "KeywordsDataErrorsRequestInfo": { "type": "object", "properties": { "limit": { "type": "integer", "description": "the maximum number of returned tasks that responded with an error\noptional field\ndefault value: 1000\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned tasks\noptional field\ndefault value: 0\nif 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\nuse this field to obtain a list of tasks that returned an error filtered by a certain function\nyou can filter the results by the values you receive in the function fields of the API response\ni.e., once you receive unfiltered results, you can call this API again to filter them by function\nexample: keywords_data/keywords_for_site/task_post, postback_url, pingback_url", "nullable": true }, "datetime_from": { "type": "string", "description": "start time for filtering results\noptional field\nallows filtering results by the datetime parameter within the range of the last 7 days;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2021-11-15 12:57:46 +00:00", "nullable": true }, "datetime_to": { "type": "string", "description": "finish time for filtering results\noptional field\nallows filtering results by the datetime parameter within the range of the last 7 days;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2021-11-15 13:57:46 +00:00", "nullable": true } }, "example": [ { "limit": 10, "offset": 0, "filtered_function": "pingback_url" } ] }, "KeywordsDataBingKeywordsForKeywordsTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForKeywordsTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForKeywordsTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataGoogleAdsSearchVolumeTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsSearchVolumeTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsSearchVolumeTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true } } }, "KeywordsDataBingKeywordsForKeywordsTaskPostRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nyou can specify the maximum of 200 keywords with each keyword containing no more than 100 characters;\nthe specified keywords will be converted to lowercase, data will be provided in a separate array\nlearn 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 search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nsupported languages:\nEnglish, French, German", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nsupported languages:\nen, fr, de", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order\ndefault value: relevance", "nullable": true }, "keywords_negative": { "type": "array", "items": { "type": "string" }, "description": "keywords negative array\noptional field\nThese keywords will be ignored in the results array;\nYou can specify a maximum of 200 terms that you want to exclude from the results;\nthe specified keywords will be converted to lowercase format", "nullable": true }, "device": { "type": "string", "description": "device type\noptional field\nspecify this field if you want to get the data for a particular device type;\npossible values: all, mobile, desktop, tablet\ndefault value: all", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nminimal value: 24 months from today\u2019s date;\nif you don\u2019t specify this field, data will be provided for the last 12 months\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-01-01\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, data will be provided for the last 12 months;\nminimum value: two years back from today\u2019s date;\nmaximum value: one month from today\u2019s date;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-03-15\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "search_partners": { "type": "boolean", "description": "Bing search partners type\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.\ndefault value: false \u2013 results are returned for Bing, AOL, and Yahoo search networks", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "language_code": "en", "keywords": [ "average page rpm adsense", "adsense blank ads how long", "leads and prospects" ] } ] }, "KeywordsDataGoogleTrendsLocationsCountryResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsLocationsCountryTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsLocationsCountryTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsLocationsCountryResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsLocationsCountryResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_code_parent": { "type": "integer", "description": "the code of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_code_parent\": 20044\nwhere location_code_parent corresponds to:\n\"location_code\": 20044,\n\"location_name\": \"Lower Austria,Austria\"", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type\npossible values according to Google\u2019s target types", "nullable": true }, "geo_id": { "type": "string", "description": "google trends location identifier\nyou can use this field for matching obtained results with the location_code parameter specified in the request", "nullable": true } } }, "KeywordsDataClickstreamDataGlobalSearchVolumeLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataClickstreamDataGlobalSearchVolumeLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataClickstreamDataGlobalSearchVolumeLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataClickstreamDataGlobalSearchVolumeLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataClickstreamDataGlobalSearchVolumeLiveResultInfo": { "type": "object", "properties": { "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/KeywordsDataClickstreamDataGlobalSearchVolumeLiveItem" } ], "nullable": true }, "description": "contains keywords and related data", "nullable": true } } }, "KeywordsDataClickstreamDataGlobalSearchVolumeLiveItem": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nkeyword is returned with decoded %## (plus symbol \u2018+\u2019 will be decoded to a space character)", "nullable": true }, "search_volume": { "type": "integer", "description": "clickstream-based average monthly search volume rate\nrepresents the (approximate) number of searches for the given keyword idea based on clickstream\nyou can learn more about clickstream search volume in this Help Center article", "format": "int64", "nullable": true }, "country_distribution": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CountryDistribution" } ], "nullable": true }, "description": "distribution of clickstream by countries\nrepresents clickstream-based search volume in available countries, as well as its respective percentage of global search volume", "nullable": true } } }, "CountryDistribution": { "type": "object", "properties": { "country_iso_code": { "type": "string", "description": "country ISO code", "nullable": true }, "search_volume": { "type": "integer", "description": "search volume in a given country", "format": "int64", "nullable": true }, "percentage": { "type": "number", "description": "percentage of global search volume", "nullable": true } } }, "KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 20\nThe maximum number of characters for each keyword: 80\nthe keywords you specify will be converted to a lowercase format\nNote: Google Ads may return no data for certain groups of keywords\nvisit our Help Center to learn more\nAlso note that Google Ads doesn\u2019t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can\u2019t use them when setting a task;\nto learn more about which symbols and characters can be used, please refer to this article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "target": { "type": "string", "description": "target website\noptional field\nspecify a website or URL to get a list of keywords relevant to it;\nNote: if a website url is specified, you will still get keywords relevant for the entire website", "nullable": true }, "location_name": { "type": "string", "description": "full name of search engine location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_coordinate;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_code;\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format;\nthe data will be provided for the country the specified coordinates belong to;\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nen", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;\ndefault value: false \u2013 results are returned for Google search sites", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\ndate format: \"yyyy-mm-dd\"\nminimal value: 4 years from the current date\nby default, data is returned for the past 12 months;\nNote: the indicated date cannot be greater than that specified in date_to and/or yesterday\u2019s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;\nif Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nNote: the indicated date cannot be greater than yesterday\u2019s date;\nif you don\u2019t specify this field, yesterday\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2022-11-30\"", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order\ndefault value: relevance", "nullable": true }, "include_adult_keywords": { "type": "boolean", "description": "include keywords associated with adult content\noptional field\nif set to true, adult keywords will be included in the response\ndefault value: false\nnote that the API may return no data for such keywords due to Google Ads restrictions", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "keywords": [ "phone", "cellphone" ] } ] }, "KeywordsDataDataforseoTrendsDemographyLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nthe maximum number of keywords you can specify: 5\navoid symbols and special characters (e.g., UTF symbols, emojis);\nspecifying non-Latin characters, you\u2019ll get data for the countries where they are used\nlearn 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 search engine location\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nnote that the data will be provided for the country the specified location_name belongs to;\nexample:\nUnited Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nnote that the data will be provided for the country the specified location_code belongs to;\nexample:\n2840", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nif you don\u2019t specify this field, the current day and month of the preceding year will be used by default\nminimal value for the web type: 2004-01-01\nminimal value for other types: 2008-01-01\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, the today\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "time_range": { "type": "string", "description": "preset time ranges\noptional field\nif you specify date_from or date_to parameters, this field will be ignored when setting a task\npossible values for all type parameters:\npast_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "keywords": [ "rugby", "cricket" ], "date_from": "2026-01-15", "date_to": "2026-03-15", "type": "web", "location_name": "United States" } ] }, "KeywordsDataDataforseoTrendsLocationsCountryResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsLocationsCountryTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsLocationsCountryTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsLocationsCountryResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsLocationsCountryResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_code_parent": { "type": "integer", "description": "the code of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_code_parent\": 20044\nwhere location_code_parent corresponds to:\n\"location_code\": 20044,\n\"location_name\": \"Lower Austria,Austria\"", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type\npossible values according to Google\u2019s target types", "nullable": true }, "geo_id": { "type": "string", "description": "DataForSEO trends location identifier\nyou can use this field for matching obtained results with the location_code parameter specified in the request", "nullable": true } } }, "KeywordsDataBingAudienceEstimationTaskPostRequestInfo": { "type": "object", "properties": { "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude,radius (in km)\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n29.6821525,-82.4098881,100", "nullable": true }, "age": { "type": "array", "items": { "type": "string" }, "description": "selection of age ranges for targeting\npossible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve", "nullable": true }, "bid": { "type": "number", "description": "desired bid setting value in USD\nmaximum value: 1000", "nullable": true }, "daily_budget": { "type": "number", "description": "daily campaign budget value in USD\nmaximum value: 10000", "nullable": true }, "gender": { "type": "array", "items": { "type": "string" }, "description": "gender to target\npossible values: male, female, unknown", "nullable": true }, "industry": { "type": "array", "items": { "type": "string" }, "description": "industry of LinkedIn profile targeting\nif you use this field, you can receive the list of available industry names with industry_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries\nexample: 806301758", "nullable": true }, "job_function": { "type": "array", "items": { "type": "string" }, "description": "job function of LinkedIn profile targeting\nif you use this field, you can receive the list of available job function names with job_function_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions\nexample: 806300451", "nullable": true } }, "example": [ { "location_coordinate": "29.6821525,-82.4098881,100", "age": [ "twenty_five_to_thirty_four", "eighteen_to_twenty_four", "unknown" ], "bid": 1, "daily_budget": 24, "gender": [ "male" ], "industry": [ 806303407, 806301758 ], "job_function": [ 806298607 ] } ] }, "KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 100\nthe specified keywords will be converted to lowercase, data will be provided in a separate array\nlearn 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 search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages", "nullable": true }, "device": { "type": "array", "items": { "type": "string" }, "description": "device types\noptional field\nspecify this field if you want to get the data for a particular device types\npossible values: mobile, desktop, tablet, non_smartphones\ndefault value: [\"mobile\", \"desktop\", \"tablet\", \"non_smartphones\"]", "nullable": true }, "period": { "type": "string", "description": "aggregates the returned data to a certain time period\noptional field\nspecify this field if you want to get the data in monthly, weekly or daily format\npossible values: monthly, weekly, daily\nmonthly \u2013 returns data up to past 24 months\nweekly \u2013 returns data up to past 15 weeks\ndaily \u2013 returns data up to past 45 days\ndefault value: monthly", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nminimum value: two years back from today\u2019s date\nmaximum value: one day from today\u2019s date\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-01-01\"\nNote: we do not recommend using a custom time range\nNote 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months\nif you specify the period parameter:\nwith value weekly, you will get results for the past 15 weeks\nwith value daily, you will get results for the past 45 days", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nminimum value: two years back from today\u2019s date;\nmaximum value: one day from today\u2019s date;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-03-15\"\nNote: we do not recommend using a custom time range\nNote 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months\nif you specify the period parameter:\nwith value weekly, you will get results for the past 15 weeks\nwith value daily, you will get results for the past 45 days", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "language_code": "en", "keywords": [ "10 minute timer" ] } ] }, "KeywordsDataBingAudienceEstimationTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationTaskGetResultInfo": { "type": "object", "properties": { "est_impressions": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "monthly estimated impressions range", "nullable": true }, "est_audience_size": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "monthly estimated reach user count range", "nullable": true }, "est_clicks": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "monthly estimated click count range", "nullable": true }, "est_spend": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "monthly estimated spending range", "nullable": true }, "est_cost_per_event": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "indicates the estimated cost per event with range result", "nullable": true }, "est_ctr": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "estimated click-through rate range", "nullable": true }, "suggested_bid": { "type": "number", "description": "suggested bid value under the current targeting", "nullable": true }, "suggested_budget": { "type": "number", "description": "suggested daily budget value under the current targeting and bid", "format": "double", "nullable": true }, "events_lost_to_bid": { "type": "integer", "description": "indicates event lost count due to insufficient input bid", "format": "int64", "nullable": true }, "events_lost_to_budget": { "type": "integer", "description": "indicates the event lost count due to insufficient input budget", "nullable": true }, "est_reach_audience_size": { "type": "integer", "description": "monthly estimated user count", "format": "int64", "nullable": true }, "est_reach_impressions": { "type": "integer", "description": "monthly estimated impressions", "format": "int64", "nullable": true }, "currency": { "type": "string", "description": "currency name\nexample: USDollar", "nullable": true } } }, "AudienceEstimationInfo": { "type": "object", "properties": { "high": { "type": "number", "description": "indicates the upper bound of the range result", "format": "double", "nullable": true }, "low": { "type": "number", "description": "indicates the lower bound of the range result", "format": "double", "nullable": true } } }, "KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsAdTrafficByKeywordsLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "date_interval": { "type": "string", "description": "forecasting date interval in a POST array", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\nthe value you specified when setting the task\nif true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;\nif false, the results are returned for Google search sites only", "nullable": true }, "bid": { "type": "number", "description": "the maximum custom bid\nthe bid you have specified when setting the task\nrepresents the price you are willing to pay for an ad\nthe higher value you have specified, the higher metrics and cost you receive in response\nlearn more in this help center article", "format": "int64", "nullable": true }, "match": { "type": "string", "description": "keywords match-type\ncan take the following values: exact, broad, phrase", "nullable": true }, "impressions": { "type": "integer", "description": "projected number of ad impressions\nnumber of impressions an ad is projected to get within the specified time period\nif there is no data, then the value is\u00a0null\nlearn more about impressions in this help center article", "nullable": true }, "ctr": { "type": "number", "description": "projected click through rate (CTR) of the advertisement\nnumber of clicks an ad is projected to receive divided by the number of ad impressions; the CTR is projected for the specified time period\nif there is no data, then the value is\u00a0null", "format": "double", "nullable": true }, "average_cpc": { "type": "number", "description": "the average cost-per-click value\nrepresents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;\nif there is no data, then the value is\u00a0null", "format": "double", "nullable": true }, "cost": { "type": "number", "description": "charge for an ad\namount that will be charged for running an ad within the specified time period\nif there is no data, then the value is\u00a0null", "nullable": true }, "clicks": { "type": "number", "description": "number of clicks on an ad\nnumber of clicks an ad is projected to get within the specified time period\nif there is no data, then the value is\u00a0null", "nullable": true } } }, "KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 80\nThe maximum number of words for each keyword phrase: 10\nthe keywords you specify will be converted to a lowercase format\nNote #1: Google Ads may return no data for certain groups of keywords;\nNote #2: Google Ads provides combined search volume values for groups of similar keywords\nto obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;\nNote #3: Google Ads doesn\u2019t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can\u2019t use them when setting a task;\nto learn more about which symbols and characters can be used, please refer to this article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "bid": { "type": "number", "description": "the maximum custom bid\nrequired field\nthe collected data will be based on this value\nit stands for the price you are willing to pay for an ad; the higher value you specify here, the higher values you will get in the returned metrics\nlearn more in this help center article" }, "match": { "type": "string", "description": "keywords match-type\nrequired field\ncan take the following values: exact, broad, phrase" }, "search_partners": { "type": "boolean", "description": "include Google search partners\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;\ndefault value: false \u2013 results are returned for Google search sites", "nullable": true }, "location_name": { "type": "string", "description": "full name of search engine location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_coordinate;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_code;\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format;\nthe data will be provided for the country the specified coordinates belong to;\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nen", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the forecasting time range\nrequired field if you specify date_to\nif you indicate date_from and date_to, you don\u2019t need to specify date_interval\nminimum value is tomorrow\u2019s date\nthe value you specify in date_from shouldn\u2019t be further than date_to\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2021-10-30\"if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;\nif Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the forecasting time range\nrequired field if you specify date_from\nif you indicate date_from and date_to, you don\u2019t need to specify date_interval\nminimum value is date_from +1 day\nmaximum value is current day and month of the next year\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2022-10-30\"", "nullable": true }, "date_interval": { "type": "string", "description": "forecasting date interval\noptional field\nif you specify date_interval, you don\u2019t need to indicate date_from and date_to\npossible values: next_week, next_month, next_quarter\ndefault value: next_month", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by relevance, impressions, ctr, average_cpc, cost, or clicks in the descending order\ndefault value: relevance", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "language_code": "en", "location_code": 2840, "bid": 999, "match": "exact", "keywords": [ "seo marketing" ] } ] }, "KeywordsDataClickstreamDataDataforseoSearchVolumeLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "target keywords\nrequired field\nUTF-8 encoding\nmaximum number of keywords you can specify in this array: 1000\nthe keywords will be converted to lowercase format\nNote: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed\nto learn more about which symbols and characters can be used, please refer to this article\nlearn 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 search engine location\nrequired field if you don\u2019t specify location_code \nyou can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages\nexample:\nUnited Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\nif you use this field, you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages\nexample:\n2826", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if don\u2019t specify language_code\nyou can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if don\u2019t specify language_name\nyou can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages\nexample:\nen", "nullable": true }, "use_clickstream": { "type": "boolean", "description": "use clickstream data to provide results\noptional field\nif set to true, you will get DataForSEO search volume values based on clickstream data;\nif set to false, Bing search volume data will be used to calculate DataForSEO search volume;\ndefault value: true;\nNote: Bing search volume is available for locations provided in Bing Search Volume History Locations and Bing Ads Locations endpoints; search volume values for any other location are calculated based on clickstream data even if you set this parameter to false", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "language_code": "en", "tag": "test-tag", "keywords": [ "you tube", "youtube", "youtub" ] } ] }, "KeywordsDataGoogleAdsSearchVolumeLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 80\nThe maximum number of words for each keyword phrase: 10\nthe keywords you specify will be converted to a lowercase format\nNote #1: Google Ads may return no data for certain groups of keywords;\nNote #2: Google Ads provides combined search volume values for groups of similar keywords\nto obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;\nNote #3: Google Ads doesn\u2019t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can\u2019t use them when setting a task;\nto learn more about which symbols and characters can be used, please refer to this article\nlearn 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 search engine location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_coordinate;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_code;\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format;\nthe data will be provided for the country the specified coordinates belong to;\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nen", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;\ndefault value: false \u2013 results are returned for Google search sites", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\ndate format: \"yyyy-mm-dd\"\nminimal value: 4 years from the current date\nby default, data is returned for the past 12 months;\nNote: the indicated date cannot be greater than that specified in date_to and/or yesterday\u2019s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;\nif Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nNote: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;\nif you don\u2019t specify this field, yesterday\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2022-11-30\"", "nullable": true }, "include_adult_keywords": { "type": "boolean", "description": "include keywords associated with adult content\noptional field\nif set to\u00a0true, adult keywords will be included in the response\ndefault value:\u00a0false\nnote\u00a0that the API may return no data for such keywords due to\u00a0Google Ads restrictions", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nuse these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order\ndefault value: relevance", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data array of the response", "nullable": true } }, "example": [ { "location_code": 2840, "keywords": [ "buy laptop", "cheap laptops for sale", "purchase laptop" ], "date_from": "2026-01-15", "search_partners": true } ] }, "KeywordsDataBingKeywordsForKeywordsTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForKeywordsTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForKeywordsTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForKeywordsTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForKeywordsTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword 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 }, "search_partners": { "type": "boolean", "description": "indicates whether data from partner networks included in the response", "nullable": true }, "device": { "type": "string", "description": "device type\nindicates for what device type the data is provided;\npossible values: all, mobile, desktop, tablet", "nullable": true }, "competition": { "type": "number", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.\nPossible values: 0.1, 0.5,0.9 \n0.1 \u2013 low competition,\n0.5 \u2013 medium competition,\n0.9 \u2013 high competition;\nif there is no data the value is null", "nullable": true }, "cpc": { "type": "number", "description": "cost-per-click\nrepresents the average cost per click (USD) historically paid for the keyword.\nif there is no data, then the value is\u00a0null", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nrepresents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user\u2019s targeting\nsearch volume is rounded to the closest decimal values\nif there is no data, then the value is\u00a0null", "format": "int64", "nullable": true }, "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "product and service categories\nlegacy field, the value will always be null", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.\nif there is no data, then the value is\u00a0null", "nullable": true } } }, "KeywordsDataBingSearchVolumeHistoryLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeHistoryLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeHistoryLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeHistoryLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeHistoryLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "device": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "period": { "type": "string", "description": "time period\nindicates if returned data is aggregated to a certain time period\ndefault value monthly", "nullable": true }, "searches": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/SearchVolumeHistorySearchInfo" } ], "description": "contains results distributed by device type\nif the device parameter is not specified, the data will be returned for all available device types", "nullable": true } } }, "SearchVolumeHistorySearchInfo": { "type": "object", "properties": { "desktop": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/SearchVolumeHistoryItemInfo" } ], "nullable": true }, "description": "device type = desktop\ncontains historical search volume data for searches made from desktop devices", "nullable": true }, "non_smartphones": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/SearchVolumeHistoryItemInfo" } ], "nullable": true }, "description": "device type = non-smartphones\ncontains historical search volume data for searches made from feature phones (non-smartphone mobile devices)", "nullable": true }, "mobile": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/SearchVolumeHistoryItemInfo" } ], "nullable": true }, "description": "device type = mobile\ncontains historical search volume data for searches made from mobile devices", "nullable": true }, "tablet": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/SearchVolumeHistoryItemInfo" } ], "nullable": true }, "description": "device type = tablet\ncontains historical search volume data for searches made from tablets", "nullable": true } } }, "SearchVolumeHistoryItemInfo": { "type": "object", "properties": { "year": { "type": "integer", "description": "year", "nullable": true }, "month": { "type": "integer", "description": "month", "nullable": true }, "day": { "type": "integer", "description": "day of the month", "nullable": true }, "search_volume": { "type": "integer", "description": "search volume rate", "format": "int64", "nullable": true } }, "description": "device type = desktop\ncontains historical search volume data for searches made from desktop devices" }, "KeywordsDataClickstreamDataGlobalSearchVolumeLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "target keywords\nrequired field\nUTF-8 encoding\nmaximum number of keywords you can specify in this array: 1000;\neach keyword should be at least 3 characters long;\nthe keywords will be converted to lowercase format;\nNote: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed\nto learn more about which symbols and characters can be used, please refer to this article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "tag": "test-tag", "keywords": [ "you tube", "youtube", "youtub" ] } ] }, "KeywordsDataGoogleAdsLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsLanguagesResultInfo": { "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 } } }, "KeywordsDataBingKeywordsForSiteLiveRequestInfo": { "type": "object", "properties": { "target": { "type": "string", "description": "domain or URL\nrequired field\nthe domain name or URL of the target website" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nsupported languages:\nEnglish, French, German", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nsupported languages:\nen, fr, de", "nullable": true }, "keywords_negative": { "type": "array", "items": { "type": "string" }, "description": "keywords negative array\noptional field\nThese keywords will be ignored in the results array;\nYou can specify a maximum of 200 terms that you want to exclude from the results;\nthe specified keywords will be converted to lowercase format", "nullable": true }, "device": { "type": "string", "description": "device type\noptional field\nspecify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet\ndefault value: all", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nminimal value: 24 months from today\u2019s date;\nif you don\u2019t specify this field, data will be provided for the last 12 months\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-01-01\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, data will be provided for the last 12 months;\nminimum value: two years back from today\u2019s date;\nmaximum value: one month from today\u2019s date;\nnote: we do not recommend using a custom time range for the past year\u2019s dates;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-03-15\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order\ndefault value: relevance", "nullable": true }, "search_partners": { "type": "boolean", "description": "Bing search partners type\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.\ndefault value: false \u2013 results are returned for Bing, AOL, and Yahoo search networks", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "language_code": "en", "location_code": 2840, "target": "dataforseo.com" } ] }, "KeywordsDataGoogleAdsKeywordsForSiteTaskPostRequestInfo": { "type": "object", "properties": { "target": { "type": "string", "description": "domain or page\nrequired field\nthe domain name of the target website or the url of the target page;\nnote: to obtain keywords for the target website, use the target_type parameter" }, "target_type": { "type": "string", "description": "search keywords for site or url\noptional field\npossible values: site, page;\ndefault value: page\nif set to site, keywords will be provided for the entire site;\nif set to page, keywords will be provided for the specified webpage", "nullable": true }, "location_name": { "type": "string", "description": "full name of search engine location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_coordinate;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_code;\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format;\nthe data will be provided for the country the specified coordinates belong to;\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nen", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;\ndefault value: false \u2013 results are returned for Google search sites", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\ndate format: \"yyyy-mm-dd\"\nminimal value: 4 years from the current date\nby default, data is returned for the past 12 months;\nNote: the indicated date cannot be greater than that specified in date_to and/or yesterday\u2019s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;\nif Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nNote: the indicated date cannot be greater than yesterday\u2019s date;\nif you don\u2019t specify this field, yesterday\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2022-11-30\"", "nullable": true }, "include_adult_keywords": { "type": "boolean", "description": "include keywords associated with adult content\noptional field\nif set to true, adult keywords will be included in the response\ndefault value: false\nnote that the API may return no data for such keywords due to Google Ads restrictions", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order\ndefault value: relevance", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "target": "dataforseo.com" } ] }, "KeywordsDataDataforseoTrendsLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsLocationsResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_code_parent": { "type": "integer", "description": "the code of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_code_parent\": 20044\nwhere location_code_parent corresponds to:\n\"location_code\": 20044,\n\"location_name\": \"Lower Austria,Austria\"", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type\npossible values according to Google\u2019s target types", "nullable": true }, "geo_id": { "type": "string", "description": "DataForSEO trends location identifier\nyou can use this field for matching obtained results with the location_code parameter specified in the request", "nullable": true } } }, "KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true } } }, "KeywordsDataGoogleTrendsExploreTaskPostRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nthe maximum number of keywords you can specify: 5\nthe maximum number of characters you can specify in a keyword: 100\nthe minimum number of characters must be greater than 1\ncomma characters (,) in the specified keywords will be unset and ignored\nNote: keywords cannot consist of a combination of the following characters: < > | \\ \" - + = ~ ! : * ( ) [ ] { }\nNote: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword\nlearn 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 search engine location\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_code\nyou can use this field as an array to set several locations, each corresponding to a specific keyword \u2013 learn more;\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations\nexample:\nUnited Kingdom", "nullable": true }, "location_code": { "type": "string", "description": "search engine location code\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_name\nyou can use this field as an array to set several locations, each corresponding to a specific keyword \u2013 learn more;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations\nexample:\n2840", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\ndefault value: English\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\ndefault value: en\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages\nexample:\nen", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "category_code": { "type": "integer", "description": "google trends search category\noptional field\nif you don\u2019t specify this field, the 0 value will be applied by default and the search will be carried out across all available categories\nyou can receive the list of available categories with their category_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google_trends/categories", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nif you don\u2019t specify this field, the current day and month of the preceding year will be used by default\nminimal value for the web type: 2004-01-01\nminimal value for other types: 2008-01-01\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, the today\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "time_range": { "type": "string", "description": "preset time ranges\noptional field\nif you specify date_from or date_to parameters, this field will be ignored when setting a task\npossible values for all type parameters:\npast_hour, past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years\npossible values for web only:\n2004_present\npossible values for news, youtube, images, froogle:\n2008_present", "nullable": true }, "item_types": { "type": "array", "items": { "type": "string" }, "description": "types of items returned\noptional field\nto speed up the execution of the request, specify one item at a time;\npossible values:\n\"google_trends_graph\", \"google_trends_map\", \"google_trends_topics_list\",\"google_trends_queries_list\"\ndefault value:\n\"google_trends_graph\"\nNote: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword in the keywords field", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "date_from": "2026-01-15", "date_to": "2026-03-15", "type": "youtube", "category_code": 3, "keywords": [ "seo api", "rank api" ] } ] }, "KeywordsDataBingSearchVolumeTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationIndustriesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationIndustriesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationIndustriesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationIndustriesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationIndustriesResultInfo": { "type": "object", "properties": { "industry_id": { "type": "integer", "description": "ID of the industry", "format": "int64", "nullable": true }, "industry_name": { "type": "string", "description": "name of the industry", "nullable": true } } }, "KeywordsDataGoogleTrendsExploreTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsExploreTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsExploreTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsLanguagesResultInfo": { "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 } } }, "KeywordsDataGoogleAdsKeywordsForSiteTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForSiteTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForKeywordsLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 20\nThe maximum number of characters for each keyword: 80\nthe keywords you specify will be converted to a lowercase format\nNote: Google Ads may return no data for certain groups of keywords\nvisit our Help Center to learn more\nAlso note that Google Ads doesn\u2019t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can\u2019t use them when setting a task;\nto learn more about which symbols and characters can be used, please refer to this article\nlearn 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 search engine location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_coordinate;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_code;\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format;\nthe data will be provided for the country the specified coordinates belong to;\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nen", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;\ndefault value: false \u2013 results are returned for Google search sites", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\ndate format: \"yyyy-mm-dd\"\nminimal value: 4 years from the current date\nby default, data is returned for the past 12 months;\nNote: the indicated date cannot be greater than that specified in date_to and/or yesterday\u2019s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;\nif Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nNote: the indicated date cannot be greater than yesterday\u2019s date;\nif you don\u2019t specify this field, yesterday\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2022-11-30\"", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order\ndefault value: relevance", "nullable": true }, "include_adult_keywords": { "type": "boolean", "description": "include keywords associated with adult content\noptional field\nif set to true, adult keywords will be included in the response\ndefault value: false\nnote that the API may return no data for such keywords due to Google Ads restrictions", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "keywords": [ "phone", "cellphone" ] } ] }, "KeywordsDataBingKeywordsForSiteLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForSiteLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForSiteLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForSiteLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForSiteLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword 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 }, "search_partners": { "type": "boolean", "description": "indicates whether data from partner networks included in the response", "nullable": true }, "device": { "type": "string", "description": "device type in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "competition": { "type": "number", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.\nPossible values: 0.1, 0.5,0.90.1 \u2013 low competition,\n0.5 \u2013 medium competition,\n0.9 \u2013 high competition;\nif there is no data the value is null", "nullable": true }, "cpc": { "type": "number", "description": "cost-per-click\nrepresents the average cost per click (USD) historically paid for the keyword.\nif there is no data, then the value is\u00a0null", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nrepresents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user\u2019s targetingsearch volume is rounded to the closest decimal valuesif there is no data, then the value is\u00a0null", "format": "int64", "nullable": true }, "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "product and service categories\nlegacy field, the value will always be null", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.\nif there is no data, then the value is\u00a0null", "nullable": true } } }, "KeywordsDataBingKeywordPerformanceTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordPerformanceTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordPerformanceTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordPerformanceTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordPerformanceTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true }, "function": { "type": "string", "nullable": true } } }, "KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "device": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "period": { "type": "string", "description": "time period\nindicates if returned data is aggregated to a certain time period\ndefault value monthly", "nullable": true }, "searches": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/SearchVolumeHistorySearchInfo" } ], "description": "contains results distributed by device type\nif the device parameter is not specified, the data will be returned for all available device types", "nullable": true } } }, "KeywordsDataGoogleAdsLocationsCountryResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsLocationsCountryTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsLocationsCountryTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsLocationsCountryResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsLocationsCountryResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_code_parent": { "type": "integer", "description": "the code of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_code_parent\": 20044\nwhere location_code_parent corresponds to:\n\"location_code\": 20044,\n\"location_name\": \"Lower Austria,Austria\"", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type\npossible values according to Google\u2019s target types", "nullable": true } } }, "KeywordsDataBingAudienceEstimationLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationLiveResultInfo": { "type": "object", "properties": { "est_impressions": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "monthly estimated impressions range", "nullable": true }, "est_audience_size": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "monthly estimated reach user count range", "nullable": true }, "est_clicks": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "monthly estimated click count range", "nullable": true }, "est_spend": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "monthly estimated spending range", "nullable": true }, "est_cost_per_event": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "indicates the estimated cost per event with range result", "nullable": true }, "est_ctr": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AudienceEstimationInfo" } ], "description": "estimated click-through rate range", "nullable": true }, "suggested_bid": { "type": "number", "description": "suggested bid value under the current targeting", "nullable": true }, "suggested_budget": { "type": "number", "description": "suggested daily budget value under the current targeting and bid", "format": "double", "nullable": true }, "events_lost_to_bid": { "type": "integer", "description": "indicates event lost count due to insufficient input bid", "format": "int64", "nullable": true }, "events_lost_to_budget": { "type": "integer", "description": "indicates the event lost count due to insufficient input budget", "nullable": true }, "est_reach_audience_size": { "type": "integer", "description": "monthly estimated user count", "format": "int64", "nullable": true }, "est_reach_impressions": { "type": "integer", "description": "monthly estimated impressions", "format": "int64", "nullable": true }, "currency": { "type": "string", "description": "currency name\nexample: USDollar", "nullable": true } } }, "KeywordsDataBingAudienceEstimationJobFunctionsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationJobFunctionsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationJobFunctionsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingAudienceEstimationJobFunctionsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingAudienceEstimationJobFunctionsResultInfo": { "type": "object", "properties": { "job_function_id": { "type": "integer", "description": "ID of the job function", "format": "int64", "nullable": true }, "job_function_name": { "type": "string", "description": "name of the job function", "nullable": true } } }, "KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordPerformanceLocationsAndLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordPerformanceLocationsAndLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResultInfo": { "type": "object", "properties": { "language_name": { "type": "string", "description": "language name", "nullable": true }, "language_code": { "type": "string", "description": "language code", "nullable": true }, "available_locations": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AvailableLocations" } ], "nullable": true }, "description": "supported locations\ncontains locations supported in combination with a specific language", "nullable": true } } }, "AvailableLocations": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "location name", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type\npossible values:\nCountry, Region", "nullable": true } } }, "KeywordsDataErrorsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataErrorsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataErrorsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataErrorsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataErrorsResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the task", "nullable": true }, "datetime": { "type": "string", "description": "date and time when an error occurred\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-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\nerror message (see full list) or URL that caused an error", "nullable": true }, "http_url": { "type": "string", "description": "URL that caused an error\nURL you used for making an API call or pingback/postback URL", "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\nfor tasks set with a pingback/postback, this field will show the time it took your server to respond", "nullable": true }, "http_response": { "type": "string", "description": "HTTP response\nserver response", "nullable": true } } }, "KeywordsDataBingKeywordPerformanceTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordPerformanceTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordPerformanceTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataClickstreamDataLocationsAndLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataClickstreamDataLocationsAndLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataClickstreamDataLocationsAndLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataClickstreamDataLocationsAndLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataClickstreamDataLocationsAndLanguagesResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_code_parent": { "type": "string", "description": "the code of the superordinate location\nthe 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\npossible values:\nCountry", "nullable": true }, "available_languages": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AvailableLanguages" } ], "nullable": true }, "description": "supported languages\ncontains the languages which are supported for a specific location", "nullable": true } } }, "AvailableLanguages": { "type": "object", "properties": { "available_sources": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "supported sources\ncontains the sources of data supported for a specific location and language combination\nonly 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 } } }, "KeywordsDataBingSearchVolumeTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint": { "type": "string", "description": "URL for collecting the results of the task", "nullable": true }, "function": { "type": "string", "nullable": true } } }, "KeywordsDataGoogleTrendsCategoriesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsCategoriesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsCategoriesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsCategoriesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsCategoriesResultInfo": { "type": "object", "properties": { "category_code": { "type": "integer", "description": "unique google trends category identifier", "nullable": true }, "category_name": { "type": "string", "description": "name of the google trends category", "nullable": true }, "category_code_parent": { "type": "integer", "description": "the code of the superordinate category\nexample:\n\"category_code\": 1100,\n\"category_name\": \"Superhero Films\",\n\"category_code_parent\": 1097\nwhere category_code_parent corresponds to:\n\"category_code\": 1097,\n\"category_name\": \"Action & Adventure Films\"", "nullable": true } } }, "KeywordsDataBingKeywordsForSiteTaskPostRequestInfo": { "type": "object", "properties": { "target": { "type": "string", "description": "domain or URL\nrequired field\nthe URL of the webpage or the domain to scan for possible keywords" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nsupported languages:\nEnglish, French, German", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nsupported languages:\nen, fr, de", "nullable": true }, "keywords_negative": { "type": "array", "items": { "type": "string" }, "description": "keywords negative array\noptional field\nThese keywords will be ignored in the results array;\nYou can specify a maximum of 200 terms that you want to exclude from the results;\nthe specified keywords will be converted to lowercase format", "nullable": true }, "device": { "type": "string", "description": "device type\noptional field\nspecify this field if you want to get the data for a particular device type\npossible values: all, mobile, desktop, tablet\ndefault value: all", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order\ndefault value: relevance", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nminimal value: 24 months from today\u2019s date;\nif you don\u2019t specify this field, data will be provided for the last 12 months\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-01-01\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, data will be provided for the last 12 months;\nminimum value: two years back from today\u2019s date;\nmaximum value: one month from today\u2019s date;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-03-15\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "search_partners": { "type": "boolean", "description": "Bing search partners type\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.\ndefault value: false \u2013 results are returned for Bing, AOL, and Yahoo search networks", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "language_code": "en", "location_code": 2840, "target": "dataforseo.com" } ] }, "KeywordsDataBingLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingLocationsResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_code_parent": { "type": "integer", "description": "the code of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_code_parent\": 20044where location_code_parent corresponds to:\n\"location_code\": 20044,\n\"location_name\": \"Lower Austria,Austria\"", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type", "nullable": true } } }, "KeywordsDataGoogleAdsAdTrafficByKeywordsLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 80\nThe maximum number of words for each keyword phrase: 10\nthe keywords you specify will be converted to a lowercase format\nNote: Google Ads may return no data for certain groups of keywords\nvisit our Help Center to learn more\nAlso note that Google Ads doesn\u2019t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can\u2019t use them when setting a task;\nto learn more about which symbols and characters can be used, please refer to this article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "bid": { "type": "integer", "description": "the maximum custom bid\nrequired field\nthe collected data will be based on this value\nit stands for the price you are willing to pay for an ad; the higher value you specify here, the higher values you will get in the returned metrics\nlearn more in this help center article", "format": "int64" }, "match": { "type": "string", "description": "keywords match-type\nrequired field\ncan take the following values: exact, broad, phrase" }, "search_partners": { "type": "boolean", "description": "include Google search partners\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;\ndefault value: false \u2013 results are returned for Google search sites", "nullable": true }, "location_name": { "type": "string", "description": "full name of search engine location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_coordinate;\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nif you do not indicate the location, you will receive worldwide results, i.e., for all available locations;\nif you use this field, you don\u2019t need to specify location_name or location_code;\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format;\nthe data will be provided for the country the specified coordinates belong to;\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages\nexample:\nen", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the forecasting time range\nrequired field if you specify date_to\nif you indicate date_from and date_to, you don\u2019t need to specify date_interval\nminimum value is tomorrow\u2019s date\nthe value you specify in date_from shouldn\u2019t be further than date_to\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2021-10-30\"if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;\nif Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the forecasting time range\nrequired field if you specify date_from\nif you indicate date_from and date_to, you don\u2019t need to specify date_interval\nminimum value is date_from +1 day\nmaximum value is current day and month of the next year\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2022-10-30\"", "nullable": true }, "date_interval": { "type": "string", "description": "forecasting date interval\noptional field\nif you specify date_interval, you don\u2019t need to indicate date_from and date_to\npossible values: next_week, next_month, next_quarter\ndefault value: next_month", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by relevance, impressions, ctr, average_cpc, cost, or clicks in the descending order\ndefault value: relevance", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "language_code": "en", "bid": 999, "match": "exact", "keywords": [ "seo marketing" ] } ] }, "KeywordsDataBingLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingLanguagesResultInfo": { "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 } } }, "KeywordsDataClickstreamDataBulkSearchVolumeLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location 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/KeywordsDataClickstreamDataSearchVolumeLiveItem" } ], "nullable": true }, "description": "contains keywords and related data", "nullable": true } } }, "KeywordsDataClickstreamDataSearchVolumeLiveItem": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword provided in the POST array", "nullable": true }, "search_volume": { "type": "integer", "description": "current search volume rate of a keyword", "format": "int64", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly search volume rates\narray of objects with search volume rates in a certain month of a year", "nullable": true } } }, "KeywordsDataGoogleAdsKeywordsForKeywordsLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForKeywordsLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForKeywordsLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "spell": { "type": "string", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, the value is\u00a0null", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\nthe value you specified when setting the task\nif true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;\nif false, the results are returned for Google search sites only", "nullable": true }, "competition": { "type": "string", "description": "competition\nrepresents the relative level of competition associated with the given keyword in paid SERP only\npossible values: LOW, MEDIUM, HIGH\nif competition level is unknown, the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "competition_index": { "type": "integer", "description": "competition index\nthe competition index for the query indicating how competitive ad placement is for the keyword\ncan take values from 0 to 100\nthe level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available\nif not enough data is available, the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nrepresents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user\u2019s targeting\nif there is no data, the value is null", "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\nindicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)\nthe 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\nindicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)\nthe value may differ depending on the location specified in a POST request", "nullable": true }, "cpc": { "type": "number", "description": "cost per click\nindicates the amount paid (USD) for each click on the ad displayed for a given keyword", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations\nif there is no data, the value is null", "nullable": true } } }, "KeywordsDataDataforseoTrendsMergedDataLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsMergedDataLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsMergedDataLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsMergedDataLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsMergedDataLiveResultInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "keywords in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "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/BaseKeywordDataDataforseoTrendsItem" } ], "nullable": true }, "description": "keyword popularity values per location\nvalues in this array represent percentages relative to the maximum value within each region", "nullable": true } } }, "KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsMergedDataLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nthe maximum number of keywords you can specify: 5\navoid symbols and special characters (e.g., UTF symbols, emojis);\nspecifying non-Latin characters, you\u2019ll get data for the countries where they are used\nlearn 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 search engine location\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nnote that the data will be provided for the country the specified location_name belongs to;\nexample:\nUnited Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\noptional field\nif you don\u2019t use this field, you will recieve global results\nif you use this field, you don\u2019t need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nnote that the data will be provided for the country the specified location_code belongs to;\nexample:\n2840", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nif you don\u2019t specify this field, the current day and month of the preceding year will be used by default\nminimal value for the web type: 2004-01-01\nminimal value for other types: 2008-01-01\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, the today\u2019s date will be used by default\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "time_range": { "type": "string", "description": "preset time ranges\noptional field\nif you specify date_from or date_to parameters, this field will be ignored when setting a task\npossible values for all type parameters:\npast_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "keywords": [ "rugby", "cricket" ], "date_from": "2026-01-15", "date_to": "2026-03-15", "type": "web", "location_name": "United States" } ] }, "KeywordsDataClickstreamDataBulkSearchVolumeLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "target keywords\nrequired field\nUTF-8 encoding\nmaximum number of keywords you can specify in this array: 1000;\neach keyword should be at least 3 characters long;\nthe keywords will be converted to lowercase format;\nNote: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed\nto learn more about which symbols and characters can be used, please refer to this article\nlearn 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\nrequired field if you don\u2019t specify location_code\nNote: it is required to specify either location_name or location_code\nyou can receive the list of available locations with their location_name by making a separate request to the\nhttps://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages\nexample:\nUnited Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "location code\nrequired field if you don\u2019t specify location_name\nNote: it is required to specify either location_name or location_code\nyou can receive the list of available locations with their location_code by making a separate request to the\nhttps://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages\nexample:\n2840", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_code": 2840, "tag": "test-tag", "keywords": [ "you tube", "youtube", "youtub" ] } ] }, "KeywordsDataGoogleTrendsExploreLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsExploreLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsExploreLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleTrendsExploreLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleTrendsExploreLiveResultInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "keywords in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to the Google Trends results\nyou 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\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "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/BaseKeywordDataGoogleTrendsItem" } ], "nullable": true }, "description": "items on the Google Trends page", "nullable": true } } }, "KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo": { "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 }, "available_locations": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AvailableLocations" } ], "nullable": true }, "description": "array of available locations for a certain language", "nullable": true } } }, "KeywordsDataIdListRequestInfo": { "type": "object", "properties": { "datetime_from": { "type": "string", "description": "start time for filtering results\nrequired field\nif include_metadata is set to true, maximum value: a month from current datetime;\nif include_metadata is set to false, maximum value: six months from current datetime;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-15 12:57:46 +00:00" }, "datetime_to": { "type": "string", "description": "finish time for filtering results\nrequired field\nmaximum value: current datetime;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-31 13:57:46 +00:00" }, "limit": { "type": "integer", "description": "the maximum number of returned task IDs\noptional field\ndefault value: 1000\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned task IDs\noptional field\ndefault value: 0\nif 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\noptional field\npossible values: \"asc\", \"desc\"\ndefault value: \"asc\"", "nullable": true }, "include_metadata": { "type": "boolean", "description": "include task metadata in the respond\noptional field\ndefault 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 } ] }, "KeywordsDataGoogleAdsSearchVolumeTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsSearchVolumeTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsSearchVolumeTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character)", "nullable": true }, "spell": { "type": "string", "description": "correct spelling of the keyword\nNote:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;\nwe use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "search_partners": { "type": "boolean", "description": "indicates whether data from partner networks included in the response", "nullable": true }, "competition": { "type": "string", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only;\nthis value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW;\nif there is no data the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "competition_index": { "type": "integer", "description": "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only;\nthis value is based on Google Ads data and can be between 0 and 100 (inclusive);\nif there is no data the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate", "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\nindicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);\nthe 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\nindicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);\nthe value may differ depending on the location specified in a POST request", "nullable": true }, "cpc": { "type": "number", "description": "cost per click\nindicates the amount paid (USD) for each click on the ad displayed for a given keyword", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months by default), targeted to the specified geographic locations;\nif there is no data then the value is\u00a0null", "nullable": true } } }, "KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "spell": { "type": "string", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, the value is\u00a0null", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\nthe value you specified when setting the task\nif true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;\nif false, the results are returned for Google search sites only", "nullable": true }, "competition": { "type": "string", "description": "competition\nrepresents the relative level of competition associated with the given keyword in paid SERP only\npossible values: LOW, MEDIUM, HIGH\nif competition level is unknown, the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "competition_index": { "type": "integer", "description": "competition index\nthe competition index for the query indicating how competitive ad placement is for the keyword\ncan take values from 0 to 100\nthe level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available\nif not enough data is available, the value is null;\nlearn more about the metric in this help center article", "nullable": true }, "search_volume": { "type": "integer", "description": "monthly average search volume rate\nrepresents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user\u2019s targeting\nif there is no data, the value is null", "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\nindicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)\nthe 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\nindicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)\nthe value may differ depending on the location specified in a POST request", "nullable": true }, "cpc": { "type": "number", "description": "cost per click\nindicates the amount paid (USD) for each click on the ad displayed for a given keyword", "nullable": true }, "monthly_searches": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MonthlySearchesInfo" } ], "nullable": true }, "description": "monthly searches\nrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations\nif there is no data, the value is null", "nullable": true } } }, "KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array\nmetrics are provided for all the keywords specified in the POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "date_interval": { "type": "string", "description": "forecasting date interval in a POST array", "nullable": true }, "search_partners": { "type": "boolean", "description": "include Google search partners\nthe value you specified when setting the task\nif true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;\nif false, the results are returned for Google search sites only", "nullable": true }, "bid": { "type": "number", "description": "the maximum custom bid\nthe bid you have specified when setting the task\nrepresents the price you are willing to pay for an ad\nthe higher value you have specified, the higher metrics and cost you receive in response\nlearn more in this help center article", "nullable": true }, "match": { "type": "string", "description": "keywords match-type\ncan take the following values: exact, broad, phrase", "nullable": true }, "impressions": { "type": "integer", "description": "projected number of ad impressions\nnumber of impressions an ad is projected to get within the specified time period\nif there is no data, then the value is\u00a0null\nlearn more about impressions in this help center article", "nullable": true }, "ctr": { "type": "number", "description": "projected clickthrough rate (CTR) of the advertisement\nnumber of clicks an ad is projected to receive divided by the number of ad impressions; the CTR is projected for the specified time period\nif there is no data, then the value is\u00a0null", "format": "double", "nullable": true }, "average_cpc": { "type": "number", "description": "the average cost-per-click value\nrepresents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;\nif there is no data, then the value is\u00a0null", "format": "double", "nullable": true }, "cost": { "type": "number", "description": "charge for an ad\namount that will be charged for running an ad within the specified time period\nif there is no data, then the value is\u00a0null", "nullable": true }, "clicks": { "type": "number", "description": "number of clicks on an ad\nnumber of clicks an ad is projected to get within the specified time period\nif there is no data, then the value is\u00a0null", "nullable": true } } }, "KeywordsDataBingSearchVolumeLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 1000\nThe maximum number of characters for each keyword: 100\nthe specified keywords will be converted to lowercase, data will be provided in a separate array\nlearn 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 search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nsupported languages:\nEnglish, French, German", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nsupported languages:\nen, fr, de", "nullable": true }, "device": { "type": "string", "description": "device type\noptional field\nspecify this field if you want to get the data for a particular device type;\npossible values: all, mobile, desktop, tablet\ndefault value: all", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order\ndefault value: relevance", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nminimal value: 24 months from today\u2019s date\nif you don\u2019t specify this field, data will be provided for the last 12 months\nminimum value: two years back from today\u2019s date\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-01-01\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, data will be provided for the last 12 months;\nminimum value: two years back from today\u2019s date;\nmaximum value: one month from today\u2019s date;\nnote: we do not recommend using a custom time range for the past year\u2019s dates;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-03-15\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "search_partners": { "type": "boolean", "description": "Bing search partners type\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.\ndefault value: false \u2013 results are returned for Bing, AOL, and Yahoo search networks", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_name": "United States", "language_code": "en", "keywords": [ "tom and jerry", "silicon valley", "spider man" ] } ] }, "KeywordsDataBingKeywordsForKeywordsLiveRequestInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" }, "description": "keywords\nrequired field\nyou can specify the maximum of 200 keywords with each keyword containing no more than 100 characters;\nthe specified keywords will be converted to lowercase, data will be provided in a separate array\nlearn 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 search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\nLondon,England,United Kingdom", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name or location_coordinate\nif you use this field, you don\u2019t need to specify location_name or location_coordinate\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name or location_code\nif you use this field, you don\u2019t need to specify location_name or location_code\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude\u201d format\nthe data will be provided for the country the specified coordinates belong to\nexample:\n52.6178549,-155.352142", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nsupported languages:\nEnglish, French, German", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nsupported languages:\nen, fr, de", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nUse these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order\ndefault value: relevance", "nullable": true }, "keywords_negative": { "type": "array", "items": { "type": "string" }, "description": "keywords negative array\noptional field\nThese keywords will be ignored in the results array;\nYou can specify a maximum of 200 terms that you want to exclude from the results;\nthe specified keywords will be converted to lowercase format", "nullable": true }, "device": { "type": "string", "description": "device type\noptional field\nspecify this field if you want to get the data for a particular device type;\npossible values: all, mobile, desktop, tablet\ndefault value: all", "nullable": true }, "date_from": { "type": "string", "description": "starting date of the time range\noptional field\nminimal value: 24 months from today\u2019s date;\nif you don\u2019t specify this field, data will be provided for the last 12 months\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-01-01\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "date_to": { "type": "string", "description": "ending date of the time range\noptional field\nif you don\u2019t specify this field, data will be provided for the last 12 months;\nminimum value: two years back from today\u2019s date;\nmaximum value: one month from today\u2019s date;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2020-03-15\"\nNote: we do not recommend using a custom time range for the past year\u2019s dates", "nullable": true }, "search_partners": { "type": "boolean", "description": "Bing search partners type\noptional field\nif you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.\ndefault value: false \u2013 results are returned for Bing, AOL, and Yahoo search networks", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "location_name": "United States", "language_name": "English", "keywords": [ "average page rpm adsense", "adsense blank ads how long", "leads and prospects" ] } ] }, "KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\n\nNote:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;\nwe use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link", "nullable": true }, "use_clickstream": { "type": "boolean", "description": "indicates if the use_clickstream parameter is active\npossible values: true, false", "nullable": true }, "items_count": { "type": "integer", "description": "ithe number of results returned in the items array", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataClickstreamDataSearchVolumeLiveItem" } ], "nullable": true }, "description": "array of keywords\ncontains keywords and their search volume rates", "nullable": true } } }, "KeywordsDataDataforseoTrendsDemographyLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsDemographyLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsDemographyLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsDemographyLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsDemographyLiveResultInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "keywords in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "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/DataforseoTrendsDemographyElementItem" } ], "nullable": true }, "description": "contains keyword popularity and related data", "nullable": true } } }, "DataforseoTrendsDemographyElementItem": { "type": "object", "allOf": [ { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BaseKeywordDataDataforseoTrendsItem" } ], "nullable": true }, { "type": "object", "properties": { "demography": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Demography" } ], "description": "demographic breakdown of keyword popularity data per each specified term\nconains keyword popularity data by age and gender", "nullable": true }, "demography_comparison": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DemographyComparisonInfo" } ], "description": "comparison of demographic data on keyword popularity for the specified parameters\nconains keyword popularity data by age and gender\nif you specified a single keyword, the value will be null", "nullable": true } } } ] }, "DemographyComparisonInfo": { "type": "object", "properties": { "age": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "nullable": true }, "nullable": true }, "description": "type of element", "nullable": true }, "gender": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "nullable": true }, "nullable": true }, "description": "type of element", "nullable": true } } }, "Demography": { "type": "object", "properties": { "age": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DataforseoTrendsDataInfo" } ], "nullable": true }, "description": "distribution of keyword popularity by age", "nullable": true }, "gender": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DataforseoTrendsDataInfo" } ], "nullable": true }, "description": "distribution of keyword popularity by gender", "nullable": true } } }, "DataforseoTrendsDataInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "relevant keyword for which demographic data is provided", "nullable": true }, "values": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DemographyItemValueInfo" } ], "nullable": true }, "description": "contains age range and corresponding keyword popularity values", "nullable": true } } }, "DemographyItemValueInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "value": { "type": "integer", "description": "keyword popularity rate within the specified age range\nusing this value you can understand how popular a keyword is within each age range;\ncalculation: we determine the highest popularity value for the relevant keyword across all age groups, and then express all other values as a percentage of that highest value (100);\na value of 100 is the highest popularity for the term\na value of 0 means there was not enough data for this term", "nullable": true } } }, "KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataIdListResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataIdListTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataIdListTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataIdListResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataIdListResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the task", "nullable": true }, "url": { "type": "string", "description": "URL of the task\nURL you used for making an API call", "nullable": true }, "datetime_posted": { "type": "string", "description": "date and time when the task was made\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-15 12:57:46 +00:00", "nullable": true }, "datetime_done": { "type": "string", "description": "date and time when the task was completed\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-15 12:57:46 +00:00", "nullable": true }, "status": { "type": "string", "description": "informational message of the task\nyou 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 } } }, "KeywordsDataGoogleAdsSearchVolumeTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsSearchVolumeTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "KeywordsDataGoogleAdsLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataGoogleAdsLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataGoogleAdsLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataGoogleAdsLocationsResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_code_parent": { "type": "integer", "description": "the code of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_code_parent\": 20044\nwhere location_code_parent corresponds to:\n\"location_code\": 20044,\n\"location_name\": \"Lower Austria,Austria\"", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type\npossible values according to Google\u2019s target types", "nullable": true } } }, "KeywordsDataDataforseoTrendsSubregionInterestsLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "keywords in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array\nif there is no data, then the value is\u00a0null", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "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/DataforseoTrendsSubregionInterestsElementItem" } ], "nullable": true }, "description": "keyword popularity values per location\nvalues in this array represent percentages relative to the maximum value within each region", "nullable": true } } }, "DataforseoTrendsSubregionInterestsElementItem": { "type": "object", "allOf": [ { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BaseKeywordDataDataforseoTrendsItem" } ], "nullable": true }, { "type": "object", "properties": { "interests": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DataforseoTrendsinterestsInfo" } ], "nullable": true }, "description": "subregional keyword popuarity data for each specified term", "nullable": true }, "interests_comparison": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InterestsComparison" } ], "description": "comparison of data on subregional keyword popularity for the specified parameters\nif you specified a single keyword, the value will be null", "nullable": true } } } ] }, "DataforseoTrendsinterestsInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "relevant keyword\nthe data included in the values element is based on this keyword", "nullable": true }, "values": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DataforseoTrendsinterestsValuesInfo" } ], "nullable": true }, "description": "contains data on relative keyword popularity by country or region", "nullable": true } } }, "DataforseoTrendsinterestsValuesInfo": { "type": "object", "properties": { "geo_id": { "type": "string", "description": "location identifier\nyou can use this field for matching obtained results with location parameters specified in the request\nsee the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nexample:\nUS-NY", "nullable": true }, "geo_name": { "type": "string", "description": "location name\nyou can use this field for matching obtained results with location parameters specified in the request\nsee the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nexample:\nAndorra", "nullable": true }, "value": { "type": "integer", "description": "relative keyword popularity rate in a given location\nrepresents location-specific keyword popularity rate over the specified time range;\nusing this value you can understand how popular a keyword is in one location compared to another location;\ncalculation: we determine the highest popularity value for the relevant keyword across all locations, and then express all other values as a percentage of that highest value (100);\na value of 100 is the highest popularity for the term\na value of 50 means that the term is half as popular\na value of 0 means there was not enough data for this term", "nullable": true } } }, "InterestsComparison": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AbsoluteItems" } ], "nullable": true }, "description": "contains keyword popularity and related data", "nullable": true }, "absolute_items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AbsoluteItems" } ], "nullable": true }, "description": "keyword popularity rates across all locations\nvalues in this array represent percentages relative to the maximum value across all locations", "nullable": true } } }, "AbsoluteItems": { "type": "object", "properties": { "geo_id": { "type": "string", "description": "location identifier\nyou can use this field for matching obtained results with location parameters specified in the request\nsee the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nexample:\nUS-NY", "nullable": true }, "geo_name": { "type": "string", "description": "location name\nyou can use this field for matching obtained results with location parameters specified in the request\nsee the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations\nexample:\nAndorra", "nullable": true }, "values": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "keyword popularity rates within a given location\nrepresents location-specific keyword popularity rate over the specified time range;\nusing these values, you can understand which of the specified keywords is more popular in the related location;\nthe first value in the array is provided for the first term from the keywords array, the second value is provided for the second keyword, and so on;\ncalculation: we determine the highest popularity value across all specified keywords within a given location, and then express the popularity values of each keyword as a percentage of the highest value (100);\na value of 100 is the peak popularity for the term\na value of 50 means that the term is half as popular\na value of 0 means there was not enough data for this term", "nullable": true } } }, "KeywordsDataBingKeywordsForSiteTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordsDataBingKeywordsForSiteTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "KeywordsDataBingKeywordsForSiteTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] } } }