{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "DataForSEO Business Data API Schemas", "definitions": { "BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo" } ], "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 } } }, "BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results", "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 } } }, "BusinessDataTripadvisorLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTripadvisorLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTripadvisorLanguagesResultInfo": { "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 } } }, "BusinessDataGoogleHotelInfoLiveAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoLiveAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoLiveAdvancedResultInfo": { "type": "object", "properties": { "hotel_identifier": { "type": "string", "description": "identifier received in a POST array\nthis field will contain the hotel_identifier parameter specified when setting a task;\nexample:\nCgoI-KWyzenM_MV3EAE", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\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 }, "title": { "type": "string", "description": "hotel title\nthe title of the hotel entity for which the results are collected", "nullable": true }, "stars": { "type": "integer", "description": "hotel class rating\nclass rating that ranges between 1-5 stars and displayed after review ratings in hotel summary", "nullable": true }, "stars_description": { "type": "string", "description": "hotel class rating\nclass rating that ranges between 1-5 stars and displayed after review ratings in the hotel summary", "nullable": true }, "address": { "type": "string", "description": "hotel address\nphysical address of the hotel", "nullable": true }, "phone": { "type": "string", "description": "hotel phone number\ncontact phone number of the hotel", "nullable": true }, "about": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelAboutInfo" } ], "description": "information about the hotel", "nullable": true }, "location": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelLocationInfo" } ], "description": "information about the hotel location\ninformation about the location where the hotel is located", "nullable": true }, "reviews": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelReviewInfo" } ], "description": "hotel reviews by criteria\ninformation about reviews of the hotel entity", "nullable": true }, "overview_images": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "images displayed in the hotel overview\narray containing URLs to images displayed in the hotel overview", "nullable": true }, "prices": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelPriceInfo" } ], "description": "pricing details of the hotel entity\ncontains information about the hotel\u2019s prices", "nullable": true } } }, "HotelLocationInfo": { "type": "object", "properties": { "neighborhood": { "type": "string", "description": "name of the neighborhood where the hotel is located", "nullable": true }, "neighborhood_description": { "type": "string", "description": "description of the neighborhood where the hotel is located", "nullable": true }, "maps_url": { "type": "string", "description": "url to the location of the hotel in google maps", "nullable": true }, "overall_score": { "type": "number", "description": "overall score of the hotel location\nindicates the overall score of the hotel\u2019s location in the range from 1 to 5;\ncalculated based on data from the hotel\u2019s proximity to nearby things to do and restaurants, transportation, and airports;\nnote that the criteria are not weighted equally in the overall score", "nullable": true }, "score_by_categories": { "type": "object", "additionalProperties": { "type": "number", "format": "double", "nullable": true }, "description": "category scores of the hotel location\nthe scores of the hotel\u2019s location tied to the categories that indicate the proximity to nearby things to do, restaurants, transportation, and airports;", "nullable": true }, "latitude": { "type": "number", "description": "hotel latitude\nlatitude coordinates of the hotel\u2019s location\nexample:\n39.4806397", "nullable": true }, "longitude": { "type": "number", "description": "hotel longitude\nlatitude coordinates of the hotel\u2019s location\nexample:\n-106.0512973", "nullable": true }, "location_chain": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/LocationChain" } ], "nullable": true }, "description": "elements of the location chain\nadditional parameters of each element of the location chain", "nullable": true } } }, "LocationChain": { "type": "object", "properties": { "card_id": { "type": "string", "description": "card identifier", "nullable": true }, "feature_id": { "type": "string", "description": "feature identifier\nlearn more about the identifier in this help center article", "nullable": true }, "cid": { "type": "string", "description": "client id\nlearn more about the identifier in this help center article", "nullable": true }, "title": { "type": "string", "description": "title of the element in the location chain", "nullable": true } } }, "HotelReviewInfo": { "type": "object", "properties": { "value": { "type": "number", "description": "overall hotel rating based on customer votes", "nullable": true }, "votes_count": { "type": "integer", "description": "number of customer votes\nthe number of customer votes included in the calculation of the hotel rating", "format": "int64", "nullable": true }, "mentions": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ReviewMentionInfo" } ], "nullable": true }, "description": "hotel mentions\ninformation about hotel reviews by criteria", "nullable": true }, "rating_distribution": { "type": "object", "additionalProperties": { "type": "integer", "format": "Int64", "nullable": true }, "description": "rating distribution by votes\nthe distribution of votes across the rating in the range from 1 to 5", "nullable": true }, "other_sites_reviews": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/OtherSitesReviewsInfo" } ], "nullable": true }, "description": "reviews on third-party sites\nreviews from third-paty sites", "nullable": true } } }, "ReviewMentionInfo": { "type": "object", "properties": { "title": { "type": "string", "description": "title of the evaluated criterion", "nullable": true }, "positive_score": { "type": "number", "description": "positive score by criterion", "nullable": true }, "positive_count": { "type": "integer", "description": "count of positive reviews by criterion", "format": "int64", "nullable": true }, "negative_count": { "type": "integer", "description": "count of negative reviews by criterion", "format": "int64", "nullable": true }, "total_count": { "type": "integer", "description": "count of all reviews by criterion", "format": "int64", "nullable": true }, "visible_by_default": { "type": "boolean", "description": "element is visible by default\nindicates whether the review element is visible by default", "nullable": true } } }, "OtherSitesReviewsInfo": { "type": "object", "properties": { "title": { "type": "string", "description": "review title\ncontains a name of the third-party site where review initially appeared", "nullable": true }, "url": { "type": "string", "description": "review url\nURL to the a third-party site where review initially appeared", "nullable": true }, "review_text": { "type": "string", "description": "review text\ntext of the review", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "rating in the review\ninformation about the rating enclosed in the review on a third-party site", "nullable": true } } }, "RatingInfo": { "properties": { "rating_type": { "type": "string", "description": "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax", "nullable": true }, "value": { "type": "number", "description": "the value of the rating", "format": "double", "nullable": true }, "votes_count": { "type": "integer", "description": "the amount of feedback", "format": "int64", "nullable": true }, "rating_max": { "type": "integer", "description": "the maximum value for a rating_type", "nullable": true } } }, "HotelAboutInfo": { "type": "object", "properties": { "description": { "type": "string", "description": "description of the hotel\nthe description of the hotel entity for which the results are collected", "nullable": true }, "sub_descriptions": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "additional description of the hotel\ndetails about the hotel provided in addition to the description", "nullable": true }, "check_in_time": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TimeInfo" } ], "description": "hotel check-in time\ncheck-in time indicated in the hotel listing", "nullable": true }, "check_out_time": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TimeInfo" } ], "description": "hotel check-out time\ncheck-out time indicated in the hotel listing", "nullable": true }, "full_address": { "type": "string", "description": "full address of the hotel\naddress of the hotel indicated in the standardised format", "nullable": true }, "domain": { "type": "string", "description": "hotel domain\ndomain of the hotel\u2019s website", "nullable": true }, "url": { "type": "string", "description": "hotel url\nURL to the hotel\u2019s website indicated in the listing", "nullable": true }, "amenities": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelAmenityInfo" } ], "nullable": true }, "description": "hotel amenities\ninformation about hotel amenities", "nullable": true }, "popular_amenities": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelAmenityItemInfo" } ], "nullable": true }, "description": "hotel amenities\ninformation about hotel amenities labelled as \u201cpopular\u201d", "nullable": true } } }, "HotelAmenityInfo": { "type": "object", "properties": { "category": { "type": "string", "description": "standardised category of the ammenity", "nullable": true }, "category_label": { "type": "string", "description": "label of the category", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelAmenityItemInfo" } ], "nullable": true }, "description": "specific amenities and details", "nullable": true } } }, "HotelAmenityItemInfo": { "type": "object", "properties": { "amenity": { "type": "string", "description": "standardised amenity name", "nullable": true }, "amenity_label": { "type": "string", "description": "displayed amenity name", "nullable": true }, "hint": { "type": "string", "description": "standardised details about the amenity", "nullable": true }, "hint_label": { "type": "string", "description": "displayed details about the amenity", "nullable": true }, "is_available": { "type": "boolean", "description": "indicates whether the amenity is available in the hotel", "nullable": true } } }, "TimeInfo": { "type": "object", "properties": { "hour": { "type": "integer", "description": "hours in the 24-hour format", "nullable": true }, "minute": { "type": "integer", "description": "minutes", "nullable": true } } }, "HotelPriceInfo": { "type": "object", "properties": { "price": { "type": "number", "description": "price per night", "nullable": true }, "price_without_discount": { "type": "number", "description": "full price per night without a discount applied", "format": "int64", "nullable": true }, "currency": { "type": "string", "description": "price currency\nUSD is applied by default, unless specified in the POST array", "nullable": true }, "discount_text": { "type": "string", "description": "text about a discount applied", "nullable": true }, "check_in": { "type": "string", "description": "check-in date and time\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "check_out": { "type": "string", "description": "check-out date and time\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "visitors": { "type": "integer", "description": "number of hotel visitors for this price", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelPriceItemInfo" } ], "nullable": true }, "description": "encountered item types\ntypes of search engine results encountered in the items array;\npossible item types: hotel_search_item", "nullable": true }, "prices_by_dates": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PricesByDates" } ], "nullable": true }, "nullable": true } } }, "HotelPriceItemInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "title": { "type": "string", "description": "title of the hotel", "nullable": true }, "price": { "type": "number", "description": "price per night", "nullable": true }, "currency": { "type": "string", "description": "price currency\nUSD is applied by default, unless specified in the POST array", "nullable": true }, "url": { "type": "string", "description": "third-party page url\nURL to the third-party website page with pricing information", "nullable": true }, "domain": { "type": "string", "description": "third-party domain\ndomain of the third-party website page with pricing information", "nullable": true }, "is_paid": { "type": "boolean", "description": "indicates a paid hotel listing\nif true, related hotel_search_item is a paid ad\nif false, related hotel_search_item is an organic hotel listing", "nullable": true }, "free_cancellation_until": { "type": "string", "description": "date until which free cancellation is available\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nequals null if free cancellation is not available for the selected dates", "nullable": true }, "offers": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelInfoPriceOffer" } ], "nullable": true }, "description": "featured price offers", "nullable": true } } }, "HotelInfoPriceOffer": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "title": { "type": "string", "description": "title of the hotel", "nullable": true }, "price": { "type": "number", "description": "price per night", "nullable": true }, "currency": { "type": "string", "description": "price currency\nUSD is applied by default, unless specified in the POST array", "nullable": true }, "url": { "type": "string", "description": "url of the price offer\nURL to the page of the website where price offer appears", "nullable": true }, "max_visitors": { "type": "integer", "description": "the maximal number of visitors\nthe maximum number of visitors for which the price offer is valid", "nullable": true }, "offer_images": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "price offer images\nURLs of the images featured in the price offer", "nullable": true }, "free_cancellation_until": { "type": "string", "description": "date until free cancellation is available\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nequals null if free cancellation is not available for the selected dates", "nullable": true } }, "description": "featured price offers" }, "PricesByDates": { "type": "object", "properties": { "price": { "type": "number", "description": "price per night", "nullable": true }, "currency": { "type": "string", "description": "price currency\nUSD is applied by default, unless specified in the POST array", "nullable": true }, "check_in_date": { "type": "string", "nullable": true }, "check_out_date": { "type": "string", "nullable": true } } }, "BusinessDataTripadvisorSearchTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorSearchTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTripadvisorSearchTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataGoogleHotelInfoLiveHtmlRequestInfo": { "type": "object", "properties": { "hotel_identifier": { "type": "string", "description": "unique hotel identifier\nrequired field\nunique identifier of a hotel entity in Google search;\nyou can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels element of the response), or the Hotel Searches endpoint of Business Data API\nexample:\nChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE" }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "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 with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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 maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nNote: if the coordinates are used to set a location, the search will occur in the nearest settlement;\nexample:\n53.476225,-2.243572", "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 with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "check_in": { "type": "string", "description": "check-in date\noptional field\nif you don\u2019t specify this field, tomorrow\u2019s date will be used by default;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "check_out": { "type": "string", "description": "check-out date\noptional field\nif you don\u2019t specify this field, our system will apply the date of two days from now by default;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "currency": { "type": "string", "description": "currency\noptional field\nexample:\n\"USD\"", "nullable": true }, "adults": { "type": "integer", "description": "number of adults\noptional field\nif you don\u2019t specify this field, two adults will be used by default\nexample:\n1", "nullable": true }, "children": { "type": "array", "items": { "type": "string" }, "description": "number and age of children\noptional field\nif you don\u2019t specify this field, no children will be included in the search;\nset the following value if you want to include one 14-years-old child:\n[14]\nset the following value if you want to include one 13-years-old child and one 8-years-old child:\n[13,8]", "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": [ { "language_code": "en", "location_name": "New York,New York,United States", "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE" } ] }, "BusinessDataTrustpilotSearchTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotSearchTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTrustpilotSearchTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotSearchTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTrustpilotSearchTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword in a POST array", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine 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 items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TrustpilotSearchOrganic" } ], "nullable": true }, "description": "found reviews\nyou can get more results by using the depth parameter when setting a task", "nullable": true } } }, "TrustpilotSearchOrganic": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed reviews\nabsolute position among all reviews on the list", "nullable": true }, "title": { "type": "string", "description": "title of the establishment", "nullable": true }, "domain": { "type": "string", "description": "domain of the establishment", "nullable": true }, "url": { "type": "string", "description": "URL to the establishment", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews", "format": "int64", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the rating score of the establishment submitted by reviewers", "nullable": true } } }, "BusinessDataGoogleHotelInfoLiveAdvancedRequestInfo": { "type": "object", "properties": { "hotel_identifier": { "type": "string", "description": "unique hotel identifier\nrequired field\nunique identifier of a hotel entity in Google search;\nyou can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels element of the response), or the Hotel Searches endpoint of Business Data API\nexample:\nChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE" }, "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 with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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 maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nNote: if the coordinates are used to set a location, the search will occur in the nearest settlement;\nexample:\n53.476225,-2.243572", "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 with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "check_in": { "type": "string", "description": "check-in date\noptional field\nif you don\u2019t specify this field, tomorrow\u2019s date will be used by default;\nthe value must not be earlier than today\u2019s date\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "check_out": { "type": "string", "description": "check-out date\noptional field\nif you don\u2019t specify this field, our system will apply the date of two days from now by default;\nNote: the value cannot be less than or equal to check_in;\nthe range between check_in and check_out values cannot exceed 30 days\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "currency": { "type": "string", "description": "currency\noptional field\nexample:\n\"USD\"", "nullable": true }, "adults": { "type": "integer", "description": "number of adults\noptional field\nif you don\u2019t specify this field, two adults will be used by default\nexample:\n1", "nullable": true }, "children": { "type": "array", "items": { "type": "string" }, "description": "number and age of children\noptional field\nif you don\u2019t specify this field, no children will be included in the search;\nset the following value if you want to include one 14-years-old child:\n[14]\nset the following value if you want to include one 13-years-old child and one 8-years-old child:\n[13,8]", "nullable": true }, "load_prices_by_dates": { "type": "boolean", "description": "load hotel stay prices by dates\noptional field\nif you specify this parameter with true, the response will include the prices_by_dates array with hotel stay prices divided by dates\nif you use this parameter, you will be charged double the base price for a request", "nullable": true }, "prices_start_date": { "type": "string", "description": "start date to load prices by dates\noptional field\nto use this parameter, you must specify load_prices_by_dates with true\nif this parameter is not specified, the start date is set to check_in date\ndate format: yyyy-mm-dd\nexample:\n2025-05-20", "nullable": true }, "prices_end_date": { "type": "string", "description": "end date to load prices by dates\noptional field\nto use this parameter, you must specify load_prices_by_dates with true\nif this parameter is not specified, you will get prices by date for the month\ndate format: yyyy-mm-dd\nexample:\n2025-05-21", "nullable": true }, "prices_date_range": { "type": "string", "description": "predefined period for retrieving daily price data\noptional field\nto use this parameter, you must specify load_prices_by_dates with true\nif the prices_start_date is not specified, the start date is set to check_in date\npossible values: month, three_months, six_months, year\ndefault value: month", "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_name": "New York,New York,United States", "hotel_identifier": "CgoI-KWyzenM_MV3EAE" } ] }, "BusinessDataGoogleHotelSearchesTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelSearchesTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelSearchesTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelSearchesTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleHotelSearchesTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST array\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character);\nin order to obtain accurate search results, the location name is appended to the keyword automatically", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\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": "item types\nthe number of items in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelSearchesItem" } ], "nullable": true }, "description": "array of items\nnote: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint", "nullable": true } } }, "BusinessDataGoogleHotelSearchesItem": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "hotel_identifier": { "type": "string", "description": "unique identifier of a hotel entity in Google search\nexample:\nCgoI-KWyzenM_MV3EAE", "nullable": true }, "title": { "type": "string", "description": "title of the hotel", "nullable": true }, "stars": { "type": "integer", "description": "hotel class rating\nclass rating that ranges between 1-5 stars", "nullable": true }, "is_paid": { "type": "boolean", "description": "indicates a paid hotel listing\nif true, related hotel_search_item is a paid ad\nif false, related hotel_search_item is an organic hotel listing", "nullable": true }, "location": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GpsCoordinatesLocationInfo" } ], "description": "GPS coordinates of the hotel\u2019s location", "nullable": true }, "reviews": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelReviewInfo" } ], "description": "hotel reviews and rating information", "nullable": true }, "overview_images": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "featured images for a hotel", "nullable": true }, "prices": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelPriceInfo" } ], "description": "hotel price", "nullable": true } } }, "GpsCoordinatesLocationInfo": { "type": "object", "properties": { "latitude": { "type": "number", "description": "latitude coordinate of the hotel in google maps\nexample:\n\"latitude\": 51.584091", "nullable": true }, "longitude": { "type": "number", "description": "longitude coordinate of the hotel in google maps\nexample:\n\"longitude\": -0.31365919999999997", "nullable": true } } }, "BusinessDataBusinessListingsSearchLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsSearchLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataBusinessListingsSearchLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsSearchLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataBusinessListingsSearchLiveResultInfo": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "total number of results in our database relevant to your request", "format": "int64", "nullable": true }, "count": { "type": "integer", "description": "item types\nthe number of items in the items array", "format": "int64", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned businesses", "format": "int64", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\nby specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task;\noffset_token values are unique for each subsequent task", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsSearchLiveItem" } ], "nullable": true }, "description": "encountered item types\ntypes of search engine results encountered in the items array;\npossible item types: business_listing", "nullable": true } } }, "BusinessDataBusinessListingsSearchLiveItem": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "title": { "type": "string", "description": "title of the element in SERP\nthe name of the business entity for which the results are collected", "nullable": true }, "original_title": { "type": "string", "description": "original title of the element\noriginal title not translated by Google", "nullable": true }, "description": { "type": "string", "description": "description of the element in SERP\nthe description of the business entity for which the results are collected", "nullable": true }, "category": { "type": "string", "description": "business category\nGoogle My Business general category that best describes the services provided by the business entity", "nullable": true }, "category_ids": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "global category IDs\nuniversal category IDs that do not change based on the selected country", "nullable": true }, "additional_categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "additional business categories\nadditional Google My Business categories that describe the services provided by the business entity in more detail", "nullable": true }, "cid": { "type": "string", "description": "google-defined client id\nunique id of a local establishment\nlearn more about the identifier in this help center article", "nullable": true }, "feature_id": { "type": "string", "description": "the unique identifier of the element in SERP\nlearn more about the identifier in this help center article", "nullable": true }, "address": { "type": "string", "description": "address of the business entity", "nullable": true }, "address_info": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressInfo" } ], "description": "object containing address components of the business entity", "nullable": true }, "place_id": { "type": "string", "description": "unique place identifier\nplace id of the local establishment featured in the element\nlearn more about the identifier in this help center article", "nullable": true }, "phone": { "type": "string", "description": "phone number of the business entity", "nullable": true }, "url": { "type": "string", "description": "absolute url of the business entity", "nullable": true }, "domain": { "type": "string", "description": "domain of the business entity", "nullable": true }, "logo": { "type": "string", "description": "URL of the logo featured in Google My Business profile", "nullable": true }, "main_image": { "type": "string", "description": "URL of the main image featured in Google My Business profile", "nullable": true }, "total_photos": { "type": "integer", "description": "total count of images featured in Google My Business profile", "format": "int64", "nullable": true }, "snippet": { "type": "string", "description": "additional information on the business entity", "nullable": true }, "latitude": { "type": "number", "description": "latitude coordinate of the local establishments in google maps\nexample:\n\"latitude\": 51.584091", "nullable": true }, "longitude": { "type": "number", "description": "longitude coordinate of the local establishment in google maps\nexample:\n\"longitude\": -0.31365919999999997", "nullable": true }, "is_claimed": { "type": "boolean", "description": "shows whether the entity is verified by its owner on Google Maps", "nullable": true }, "attributes": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataAttributesInfo" } ], "description": "service details in a form of user-reviewed checks;\nservice details of a business entity displayed in a form of checks and based on user feedback and business category", "nullable": true }, "place_topics": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "keywords mentioned in customer reviews\ncontains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword\nexample: \n\"place_topics\": {\n\"egg roll\": 48,\n\"birthday\": 33\n}", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "properties": { "rating_type": { "type": "string", "description": "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax", "nullable": true }, "value": { "type": "number", "description": "the value of the rating", "format": "double", "nullable": true }, "votes_count": { "type": "integer", "description": "the amount of feedback", "format": "int64", "nullable": true }, "rating_max": { "type": "number", "description": "the maximum value for a rating_type", "format": "double", "nullable": true } }, "description": "the element\u2019s rating \nthe popularity rate based on reviews and displayed in SERP", "nullable": true }, "hotel_rating": { "type": "integer", "description": "hotel class rating\nclass ratings range between 1-5 stars, learn more\nif there is no hotel class rating information, the value will be null", "nullable": true }, "price_level": { "type": "string", "description": "property price level\ncan take values: inexpensive, moderate, expensive, very_expensive\nif there is no price level information, the value will be null", "nullable": true }, "rating_distribution": { "type": "object", "additionalProperties": { "type": "integer", "format": "Int64", "nullable": true }, "description": "the distribution of ratings of the business entity\nthe object displays the number of 1-star to 5-star ratings, as reviewed by users", "nullable": true }, "people_also_search": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PeopleAlsoSearch" } ], "nullable": true }, "description": "related business entities", "nullable": true }, "work_time": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessWorkHoursInfo" } ], "description": "work time details\ninformation related to operational hours of the business entity", "nullable": true }, "popular_times": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PopularTimes" } ], "description": "popular times\ninformation related to busy hours of the business entity", "nullable": true }, "local_business_links": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BaseLocalBusinessLink" } ], "nullable": true }, "description": "available interactions with the business\nlist of options to interact with the business directly from search results", "nullable": true }, "contact_info": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataContactInfo" } ], "nullable": true }, "description": "available contacts of the business\nlist of contacts to interact with the business", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results", "nullable": true }, "last_updated_time": { "type": "string", "description": "date and time when the data was last updated\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-26 09:03:15 +00:00", "nullable": true }, "first_seen": { "type": "string", "description": "date and time when our crawler found the business listing element for the first time\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-03-11 10:04:11 +00:00", "nullable": true } } }, "AddressInfo": { "type": "object", "properties": { "borough": { "type": "string", "description": "administrative unit or district the local establishment belongs to", "nullable": true }, "address": { "type": "string", "description": "street address of the local establishment", "nullable": true }, "city": { "type": "string", "description": "name of the city where the local establishment is located", "nullable": true }, "zip": { "type": "string", "description": "ZIP code of the local establishment", "nullable": true }, "region": { "type": "string", "description": "DMA region the local establishment belongs to", "nullable": true }, "country_code": { "type": "string", "description": "ISO country code of the local establishment", "nullable": true } } }, "BusinessDataAttributesInfo": { "type": "object", "properties": { "available_attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "description": "available attributes\nindicates attributes a business entity can offer", "nullable": true }, "unavailable_attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "description": "unavailable attributes\nindicates attributes a business entity cannot offer", "nullable": true } } }, "BusinessWorkHoursInfo": { "type": "object", "properties": { "work_hours": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkHours" } ], "description": "open hours\ninformation about work hours of the local establishment", "nullable": true } } }, "WorkHours": { "type": "object", "properties": { "timetable": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkDayInfo" } ], "description": "work hours on Sundays", "nullable": true }, "nullable": true }, "description": "work hours timetable", "nullable": true }, "current_status": { "type": "string", "description": "current status of the establishment\nindicates whether the establishment is opened or closed", "nullable": true } } }, "WorkDayInfo": { "type": "object", "properties": { "open": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TimeInfo" } ], "description": "opening time", "nullable": true }, "close": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TimeInfo" } ], "description": "closing time", "nullable": true } } }, "PopularTimes": { "type": "object", "properties": { "popular_times_by_days": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PopularWorkTimeInfo" } ], "description": "work hours on Sundays", "nullable": true }, "nullable": true }, "description": "popular hours\ninformation about busy hours of the local establishment on each day of the week", "nullable": true } } }, "PopularWorkTimeInfo": { "type": "object", "properties": { "time": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TimeInfo" } ], "description": "hours in the 24-hour format", "nullable": true }, "popular_index": { "type": "integer", "description": "popularity index\nrelative time-bound popularity index measured from 0 to 100;\nhigher value corresponds to a busier time of a day", "nullable": true } } }, "BaseLocalBusinessLink": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "reservation": "#/components/schemas/LocalBusinessReservationLink", "order": "#/components/schemas/LocalBusinessOrderLink", "menu": "#/components/schemas/LocalBusinessMenuLink" } } }, "BusinessDataContactInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "value": { "type": "string", "description": "contact displayed in SERP \nexample:\n\"+119797979736\"", "nullable": true }, "source": { "type": "string", "description": "data source", "nullable": true } } }, "PeopleAlsoSearch": { "type": "object", "properties": { "cid": { "type": "string", "description": "google-defined client id\nunique id of a local establishment\nlearn more about the identifier in this help center article", "nullable": true }, "feature_id": { "type": "string", "description": "the unique identifier of the element in SERP\nlearn more about the identifier in this help center article", "nullable": true }, "title": { "type": "string", "description": "title of the element in SERP\nthe name of the business entity for which the results are collected", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the element\u2019s rating \nthe popularity rate based on reviews and displayed in SERP", "nullable": true } } }, "BusinessDataGoogleMyBusinessUpdatesTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessUpdatesTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataGoogleMyBusinessInfoTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessInfoTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessInfoTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST array\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character)\nthis field will contain the cid parameter if you specified it in the keyword field when setting a task;\nexample:\ncid:2946633002421908862\nlearn more about the parameter in this help center article", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain as specified in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\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 }, "item_types": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "item types\ntypes of search engine results encountered in the items array;\npossible item types: google_business_info", "nullable": true }, "items_count": { "type": "integer", "description": "item types\nthe number of items in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GoogleBusinessInfo" } ], "nullable": true }, "description": "array of directory items", "nullable": true } } }, "GoogleBusinessInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the elements", "nullable": true }, "position": { "type": "string", "description": "the alignment in SERP", "nullable": true }, "title": { "type": "string", "description": "title of the element in SERP\nthe name of the business entity for which the results are collected", "nullable": true }, "original_title": { "type": "string", "description": "original title of the element\noriginal title not translated by Google", "nullable": true }, "description": { "type": "string", "description": "description of the element in SERP\nthe description of the business entity for which the results are collected", "nullable": true }, "category": { "type": "string", "description": "business category\nGoogle My Business general category that best describes the services provided by the business entity", "nullable": true }, "category_ids": { "type": "array", "items": { "type": "string" }, "description": "global category IDs\nuniversal category IDs that do not change based on the selected country", "nullable": true }, "additional_categories": { "type": "array", "items": { "type": "string" }, "description": "additional business categories\nadditional Google My Business categories that describe the services provided by the business entity in more detail", "nullable": true }, "cid": { "type": "string", "description": "google-defined client id\nunique id of a local establishment;\ncan be used with Google Reviews API to get a full list of reviews\nlearn more about the identifier in this help center article", "nullable": true }, "feature_id": { "type": "string", "description": "the unique identifier of the element in SERP\nlearn more about the identifier in this help center article", "nullable": true }, "address": { "type": "string", "description": "address of the business entity", "nullable": true }, "address_info": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressInfo" } ], "description": "object containing address components of the business entity", "nullable": true }, "place_id": { "type": "string", "description": "unique place identifier\nplace id of the local establishment featured in the element\nlearn more about the identifier in this help center article", "nullable": true }, "phone": { "type": "string", "description": "phone number of the business entity", "nullable": true }, "url": { "type": "string", "description": "absolute url of the business entity", "nullable": true }, "contact_url": { "type": "string", "description": "URL of the preferred contact page", "nullable": true }, "contributor_url": { "type": "string", "description": "URL of the user\u2019s or entity\u2019s Local Guides profile, if available", "nullable": true }, "book_online_url": { "type": "string", "description": "URL in the \u2018book online\u2019 button of the element\nURL directing users to the online booking or order page of the business entity", "nullable": true }, "domain": { "type": "string", "description": "domain of the business entity", "nullable": true }, "logo": { "type": "string", "description": "URL of the logo featured in Google My Business profile", "nullable": true }, "main_image": { "type": "string", "description": "URL of the main image featured in Google My Business profile", "nullable": true }, "total_photos": { "type": "integer", "description": "total count of images featured in Google My Business profile", "format": "int64", "nullable": true }, "snippet": { "type": "string", "description": "additional information on the business entity", "nullable": true }, "latitude": { "type": "number", "description": "latitude coordinate of the local establishments in google maps\nexample:\n\"latitude\": 51.584091", "nullable": true }, "longitude": { "type": "number", "description": "longitude coordinate of the local establishment in google maps\nexample:\n\"longitude\": -0.31365919999999997", "nullable": true }, "is_claimed": { "type": "boolean", "description": "shows whether the entity is verified by its owner on Google Maps", "nullable": true }, "questions_and_answers_count": { "type": "integer", "nullable": true }, "attributes": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataAttributesInfo" } ], "description": "service details in a form of user-reviewed checks;\nservice details of a business entity displayed in a form of checks and based on user feedback and business category", "nullable": true }, "place_topics": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "keywords mentioned in customer reviews\ncontains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword\nexample: \n\"place_topics\": {\n\"egg roll\": 48,\n\"birthday\": 33\n}", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the element\u2019s rating \nthe popularity rate based on reviews and displayed in SERP", "nullable": true }, "hotel_rating": { "type": "number", "description": "hotel class rating\nclass ratings range between 1-5 stars, learn more\nif there is no hotel class rating information, the value will be null", "nullable": true }, "price_level": { "type": "string", "description": "property price level\ncan take values: inexpensive, moderate, expensive, very_expensive\nif there is no price level information, the value will be null", "nullable": true }, "rating_distribution": { "type": "object", "additionalProperties": { "type": "integer", "format": "Int64", "nullable": true }, "description": "the distribution of ratings of the business entity\nthe object displays the number of 1-star to 5-star ratings, as reviewed by users", "nullable": true }, "people_also_search": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PeopleAlsoSearch" } ], "nullable": true }, "description": "related business entities", "nullable": true }, "work_time": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessWorkHoursInfo" } ], "description": "work time details\ninformation related to operational hours of the business entity", "nullable": true }, "popular_times": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PopularTimes" } ], "description": "popular times\ninformation related to busy hours of the business entity", "nullable": true }, "local_business_links": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BaseLocalBusinessLink" } ], "nullable": true }, "description": "available interactions with the business\nlist of options to interact with the business directly from search results", "nullable": true }, "is_directory_item": { "type": "boolean", "description": "business establishment is a part of the directory\nindicates whether the business establishment is a part of the directory;\nif true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre);\nnote: if the business establishment is a parent item in the directory, the value will be null", "nullable": true }, "directory": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDirectoryInfo" } ], "description": "items of the directory\nincludes information about businesses that are located within the target business establishment and have the same address", "nullable": true } } }, "BusinessDirectoryInfo": { "type": "object", "properties": { "title": { "type": "string", "description": "title of the element\ndomain of the online menu system", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MapsSearch" } ], "nullable": true }, "description": "encountered item types\ntypes of search engine results encountered in the items array;\npossible item types: google_business_info", "nullable": true } } }, "MapsSearch": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from the rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the elements", "nullable": true }, "domain": { "type": "string", "description": "domain of the business entity", "nullable": true }, "title": { "type": "string", "description": "directory title\ncan take the following values: At this place, Directory", "nullable": true }, "url": { "type": "string", "description": "URL to view the menu", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the element\u2019s rating \nthe popularity rate based on reviews and displayed in SERP", "nullable": true }, "rating_distribution": { "type": "object", "additionalProperties": { "type": "integer", "format": "Int64", "nullable": true }, "description": "the distribution of ratings of the business entity\nthe object displays the number of 1-star to 5-star ratings, as reviewed by users", "nullable": true }, "snippet": { "type": "string", "description": "additional information about the business entity", "nullable": true }, "address": { "type": "string", "description": "address of the business entity", "nullable": true }, "address_info": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressInfo" } ], "description": "object containing address components of the business entity", "nullable": true }, "place_id": { "type": "string", "description": "unique place identifier\nplace id of the local establishment featured in the element\nlearn more about the identifier in this help center article", "nullable": true }, "phone": { "type": "string", "description": "phone number of the business entity", "nullable": true }, "main_image": { "type": "string", "description": "URL of the main image featured in Google My Business profile", "nullable": true }, "total_photos": { "type": "string", "description": "total count of images featured in Google My Business profile", "format": "int64", "nullable": true }, "category": { "type": "string", "description": "business category\nGoogle My Business general category that best describes the services provided by the business entity", "nullable": true }, "additional_categories": { "type": "array", "items": { "type": "string" }, "description": "additional business categories\nadditional Google My Business categories that describe the services provided by the business entity in more detail", "nullable": true }, "price_level": { "type": "string", "description": "property price level\ncan take values: inexpensive, moderate, expensive, very_expensive\nif there is no price level information, the value will be null", "nullable": true }, "hotel_rating": { "type": "string", "description": "hotel class rating\nclass ratings range between 1-5 stars, learn more\nif there is no hotel class rating information, the value will be null", "nullable": true }, "category_ids": { "type": "array", "items": { "type": "string" }, "description": "global category IDs\nuniversal category IDs that do not change based on the selected country", "nullable": true }, "work_hours": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessWorkHoursInfo" } ], "description": "open hours\ninformation about work hours of the local establishment", "nullable": true }, "feature_id": { "type": "string", "description": "the unique identifier of the element in SERP\nlearn more about the identifier in this help center article", "nullable": true }, "cid": { "type": "string", "description": "google-defined client id\nunique id of a local establishment;\ncan be used with Google Reviews API to get a full list of reviews\nlearn more about the identifier in this help center article", "nullable": true }, "latitude": { "type": "number", "description": "latitude coordinate of the local establishments in google maps\nexample:\n\"latitude\": 51.584091", "nullable": true }, "longitude": { "type": "number", "description": "longitude coordinate of the local establishment in google maps\nexample:\n\"longitude\": -0.31365919999999997", "nullable": true }, "is_claimed": { "type": "boolean", "description": "shows whether the entity is verified by its owner on Google Maps", "nullable": true }, "local_justifications": { "type": "array", "items": { "type": "string" }, "description": "Google local justifications\nsnippets of text that \u201cjustify\u201d why the business is showing up for search query", "nullable": true }, "is_directory_item": { "type": "boolean", "description": "business establishment is a part of the directory\nindicates whether the business establishment is a part of the directory;\nif true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre);\nnote: if the business establishment is a parent item in the directory, the value will be null", "nullable": true } } }, "BusinessDataTrustpilotSearchTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field\nthe keyword you specify should indicate a business category or company name;\nyou can specify up to 700 characters in the keyword filed;\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character);\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of search results to be returned from the API response\nwe strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;\ndefault value: 10;\nmaximum value: 140\nYour account will be billed per each SERP containing up to 10 results;\nSetting depth above 10 may result in additional charges if the search engine returns more than 10 results;\nThe cost can be calculated on the Pricing page.", "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 }, "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 } }, "example": [ { "keyword": "pizza restaurant", "depth": 20 } ] }, "BusinessDataTripadvisorLocationsCountryResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorLocationsCountryTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTripadvisorLocationsCountryTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorLocationsCountryResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTripadvisorLocationsCountryResultInfo": { "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_name_parent": { "type": "string", "description": "the name of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_name_parent\": \"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 } } }, "BusinessDataSocialMediaRedditLiveRequestInfo": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string" }, "description": "target URLs\nrequired field\ntarget page should be specified with its absolute URL (including http:// or https://)\nexample:\nhttps://dataforseo.com/\nNote: you can specify 10 targets maximum. You will be charged per earch URL you specify in this array" }, "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": [ { "targets": [ "https://vk.com/", "https://ahrefs.com/", "https://google.com/", "https://twitter.com/", "https://reddit.com/", "https://facebook.com/" ], "tag": "some_string_123" } ] }, "BusinessDataBusinessListingsCategoriesAggregationLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataBusinessListingsCategoriesAggregationLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataBusinessListingsCategoriesAggregationLiveResultInfo": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "total number of results in our database relevant to your request", "format": "int64", "nullable": true }, "count": { "type": "integer", "description": "item types\nthe number of items in the items array", "format": "int64", "nullable": true }, "offset": { "type": "string", "description": "offset in the results array of returned categories", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\nby specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task;\noffset_token values are unique for each subsequent task", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveItem" } ], "nullable": true }, "description": "encountered item types\ntypes of search engine results encountered in the items array;\npossible item types: business_category", "nullable": true } } }, "BusinessDataBusinessListingsCategoriesAggregationLiveItem": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "business categories\nGoogle My Business general category that best describes the cluster of related categories", "nullable": true }, "aggregation": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessListingAggregationInfo" } ], "properties": { "top_categories": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "nullable": true }, "top_countries": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "nullable": true }, "top_attributes": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "nullable": true }, "top_place_topics": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "nullable": true } }, "description": "aggregation of the category", "nullable": true } } }, "BusinessListingAggregationInfo": { "type": "object", "properties": { "top_categories": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "the most mentioned related categories\ntop categories displayed with the number of businesses in each category", "nullable": true }, "top_countries": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "the most mentioned counties\ncountry codes with the biggest number of businesses in the category", "nullable": true }, "websites_count": { "type": "integer", "description": "number of unique websites", "format": "int64", "nullable": true }, "count": { "type": "integer", "description": "number of unique entities", "format": "int64", "nullable": true }, "top_attributes": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "the most mentioned service details\nservice details of a business entity displayed in a form of checks and the number of entities mentioning each attribute", "nullable": true }, "top_place_topics": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "top keywords mentioned in customer reviews\ncontains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword", "nullable": true } } }, "BusinessDataGoogleHotelSearchesTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelSearchesTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelSearchesTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataGoogleHotelSearchesTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelSearchesTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelSearchesTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelSearchesTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleHotelSearchesTasksReadyResultInfo": { "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\ncan take the following values: google", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "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 } } }, "BusinessDataTrustpilotReviewsTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotReviewsTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTrustpilotReviewsTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataTripadvisorReviewsTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorReviewsTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTripadvisorReviewsTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo": { "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\ncan take the following values: google", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "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 } } }, "BusinessDataSocialMediaPinterestLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataSocialMediaPinterestLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataSocialMediaPinterestLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataSocialMediaPinterestLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataSocialMediaPinterestLiveResultInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "page_url": { "type": "string", "description": "URL of the page the data is provided for\ncorresponding URL you specified in the targets array when setting a task", "nullable": true }, "pins_count": { "type": "integer", "description": "number of pins for the related page_url\npins on Pinterest correspond to content saves;\nthis field shows the number of content saves made from the related page_url using the Pinterest Save Button", "format": "int64", "nullable": true } } }, "BusinessDataGoogleLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleLocationsResultInfo": { "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_name_parent": { "type": "string", "description": "the name of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_name_parent\": \"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 } } }, "BusinessDataBusinessListingsLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataBusinessListingsLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataBusinessListingsLocationsResultInfo": { "type": "object", "properties": { "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "business_count": { "type": "integer", "description": "number of businesses in this location in our database", "format": "int64", "nullable": true } } }, "BusinessDataGoogleLocationsCountryResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleLocationsCountryTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleLocationsCountryTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleLocationsCountryResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleLocationsCountryResultInfo": { "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_name_parent": { "type": "string", "description": "the name of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_name_parent\": \"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 } } }, "BusinessDataGoogleHotelInfoTaskGetAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoTaskGetAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoTaskGetAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoTaskGetAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoTaskGetAdvancedResultInfo": { "type": "object", "properties": { "hotel_identifier": { "type": "string", "description": "unique hotel identifier\nthis field will contain the hotel_identifier parameter;\nexample:\nCgoI-KWyzenM_MV3EAE", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\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 }, "title": { "type": "string", "description": "hotel title\nthe title of the hotel entity for which the results are collected", "nullable": true }, "stars": { "type": "integer", "description": "hotel class rating\nclass rating that ranges between 1-5 stars and displayed after review ratings in hotel summary", "nullable": true }, "stars_description": { "type": "string", "description": "hotel class rating\nclass rating that ranges between 1-5 stars and displayed after review ratings in the hotel summary", "nullable": true }, "address": { "type": "string", "description": "hotel address\nphysical address of the hotel", "nullable": true }, "phone": { "type": "string", "description": "hotel phone number\ncontact phone number of the hotel", "nullable": true }, "about": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelAboutInfo" } ], "description": "information about the hotel", "nullable": true }, "location": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelLocationInfo" } ], "description": "information about the hotel location\ninformation about the location where the hotel is located", "nullable": true }, "reviews": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelReviewInfo" } ], "description": "hotel reviews by criteria\ninformation about reviews of the hotel entity", "nullable": true }, "overview_images": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "images displayed in the hotel overview\narray containing URLs to images displayed in the hotel overview", "nullable": true }, "prices": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HotelPriceInfo" } ], "description": "pricing details of the hotel entity\ncontains information about the hotel\u2019s prices", "nullable": true } } }, "BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST array\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character)\nthis field will contain the cid parameter if you specified it in the keyword field when setting a task;\nexample:\ncid:2946633002421908862\nlearn more about the parameter in this help center article", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain as specified in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\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 }, "cid": { "type": "string", "description": "google-defined client id\nunique id of a local establishment;\nlearn more about the identifier in this help center article", "nullable": true }, "feature_id": { "type": "string", "description": "unique identifier of the SERP feature", "nullable": true }, "item_types": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "item types\ntypes of search engine results encountered in the items array;\npossible item types: google_business_question_item", "nullable": true }, "items_without_answers": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GoogleBusinessQuestionItem" } ], "nullable": true }, "description": "array of google business question items without answers", "nullable": true }, "items_count": { "type": "integer", "description": "the number of items in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GoogleBusinessQuestionItem" } ], "nullable": true }, "description": "array of items within google_business_question_item\ncontains answers to the google business questions;\nthe maximum number of answers returned for each question: 5\npossible item types google_business_answer_element", "nullable": true } } }, "GoogleBusinessQuestionItem": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the elements", "nullable": true }, "question_id": { "type": "string", "description": "ID of the question", "nullable": true }, "url": { "type": "string", "description": "URL of the question", "nullable": true }, "profile_image_url": { "type": "string", "description": "URL of the user\u2019s profile image", "nullable": true }, "profile_url": { "type": "string", "description": "URL of the user\u2019s profile", "nullable": true }, "profile_name": { "type": "string", "description": "displayed name of the user", "nullable": true }, "question_text": { "type": "string", "description": "current text of the question", "nullable": true }, "original_question_text": { "type": "string", "description": "original text of the question", "nullable": true }, "time_ago": { "type": "string", "description": "estimated time when the question was posted", "nullable": true }, "timestamp": { "type": "string", "description": "exact time when the question was posted", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GoogleBusinessAnswerElement" } ], "nullable": true }, "description": "array of items\nitems within google_business_question_item", "nullable": true } } }, "GoogleBusinessAnswerElement": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "answer_id": { "type": "string", "description": "ID of the answer", "nullable": true }, "profile_image_url": { "type": "string", "description": "URL of the user\u2019s profile image", "nullable": true }, "profile_url": { "type": "string", "description": "URL of the user\u2019s profile", "nullable": true }, "profile_name": { "type": "string", "description": "displayed name of the user", "nullable": true }, "answer_text": { "type": "string", "description": "current text of the answer", "nullable": true }, "original_answer_text": { "type": "string", "description": "original text of the answer", "nullable": true }, "time_ago": { "type": "string", "description": "estimated time when the answer was posted", "nullable": true }, "timestamp": { "type": "string", "description": "exact time when the answer was posted", "nullable": true } } }, "BusinessDataGoogleReviewsTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleReviewsTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleReviewsTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTasksReadyResultInfo": { "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\ncan take the following values: tripadvisor", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "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 } } }, "BusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field\nthe keyword you specify should indicate the name of the local establishment\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d; \nthis field can also be used to pass the following parameters:\ncid \u2013 a unique, google-defined id of the business entity;\nplace_id \u2013 an identifier of the business entity in Google Maps;\nexample:\ncid:194604053573767737\nplace_id:GhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the cid and place_id identifiers in this help center article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "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 with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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\u201d format\nthe maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nthe minimum value for \u201cradius\u201d: 199.9 (mm)\nthe maximum value for \u201cradius\u201d: 199999 (mm)\nexample:\n53.476225,-2.243572,200", "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 with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of question rows in the result\ndefault value: 20\nmax value: 700\nYour account will be billed per each SERP containing up to 20 results;\nSetting depth above 20 may result in additional charges if the search engine returns more than 20 results;\nIf the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;\nThe cost can be calculated on the Pricing page.", "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 }, "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 } }, "example": [ { "language_code": "en", "location_name": "Los Angeles,California,United States", "keyword": "The Last Bookstore" } ] }, "BusinessDataGoogleExtendedReviewsTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleExtendedReviewsTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleExtendedReviewsTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleExtendedReviewsTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleExtendedReviewsTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST array\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character)", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\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 }, "title": { "type": "string", "description": "title of the \u2018reviews\u2019 element in SERP\nthe name of the local establishment for which the reviews are collected", "nullable": true }, "sub_title": { "type": "string", "description": "subtitle of the \u2018reviews\u2019 element in SERP\nadditional information (e.g., address) on the \u2018reviews\u2019 element for which the reviews are collected", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "rating of the corresponding local establishment\npopularity rate based on reviews and displayed in SERP", "nullable": true }, "feature_id": { "type": "string", "description": "the unique identifier of the \u2018reviews\u2019 element in SERP\nlearn more about the identifier in this help center article", "nullable": true }, "place_id": { "type": "string", "description": "unique identifier of a business location assigned by Google\nlearn more about the identifier in this help center article", "nullable": true }, "cid": { "type": "string", "description": "google-defined client id\nunique id of a local establishment\nlearn more about the identifier in this help center article", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of reviews items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GoogleExtendedReviewsSearch" } ], "nullable": true }, "description": "found reviews\nyou can get more results by using the depth parameter when setting a task", "nullable": true } } }, "GoogleExtendedReviewsSearch": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed reviews\nabsolute position among all reviews on the list", "nullable": true }, "position": { "type": "string", "description": "the alignment of the review in SERP\ncan take the following values: right", "nullable": true }, "xpath": { "type": "string", "description": "the XPath of the review", "nullable": true }, "review_text": { "type": "string", "description": "the content of the review", "nullable": true }, "original_review_text": { "type": "string", "description": "original content of the review\nthe original content of the review, no auto-translate applied", "nullable": true }, "time_ago": { "type": "string", "description": "the time of publication\nindicates the time (in the \u2018time ago\u2019 format) when the review was listed", "nullable": true }, "timestamp": { "type": "string", "description": "date and time when a review was published\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the rating score submitted by the reviewer", "nullable": true }, "reviews_count": { "type": "integer", "description": "total number of reviews submitted by the reviewer", "format": "int64", "nullable": true }, "photos_count": { "type": "integer", "description": "total number of photos submitted by the reviewer", "format": "int64", "nullable": true }, "local_guide": { "type": "boolean", "description": "indicates whether the reviewer has a \u2018local guide\u2019 status", "nullable": true }, "profile_name": { "type": "string", "description": "profile name of the reviewer", "nullable": true }, "profile_url": { "type": "string", "description": "URL of the reviewer\u2019s profile", "nullable": true }, "review_url": { "type": "string", "description": "the URL of the review", "nullable": true }, "profile_image_url": { "type": "string", "description": "URL of the reviewer\u2019s profile image", "nullable": true }, "owner_answer": { "type": "string", "description": "text of the owner\u2019s response\nthe owner\u2019s response to the review", "nullable": true }, "original_owner_answer": { "type": "string", "description": "original text of the owner\u2019s response\nthe original response to the review, no auto-translate applied", "nullable": true }, "owner_time_ago": { "type": "string", "description": "publication time\nindicates the time (in the \u2018time ago\u2019 format) when the owner submitted the response to the review", "nullable": true }, "owner_timestamp": { "type": "string", "description": "date and time of the owner\u2019s reply to the review\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "review_id": { "type": "string", "description": "the unique identifier of a review on Google\nexample:\nChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE", "nullable": true }, "images": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AiModeImagesElementInfo" } ], "nullable": true }, "description": "images submitted by the reviewer", "nullable": true }, "review_highlights": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ReviewHighlights" } ], "nullable": true }, "description": "review highlights\ncontains highlighted review criteria and assessments", "nullable": true }, "source": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Source" } ], "description": "source of the review\ncontains information about the source where the review was posted", "nullable": true } } }, "AiModeImagesElementInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "alt": { "type": "string", "description": "alt tag of the image", "nullable": true }, "url": { "type": "string", "description": "URL link", "nullable": true }, "image_url": { "type": "string", "description": "URL of the image\nthe URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)", "nullable": true } } }, "ReviewHighlights": { "type": "object", "properties": { "feature": { "type": "string", "description": "reviewed feature", "nullable": true }, "assessment": { "type": "string", "description": "feature assessment", "nullable": true } } }, "Source": { "type": "object", "properties": { "title": { "type": "string", "description": "name of the source where the review was posted", "nullable": true }, "image": { "type": "string", "description": "featured image of the source", "nullable": true }, "domain": { "type": "string", "description": "domain of the source where the review was posted", "nullable": true } } }, "BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataTripadvisorReviewsTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorReviewsTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTripadvisorReviewsTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorReviewsTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTripadvisorReviewsTaskGetResultInfo": { "type": "object", "properties": { "url_path": { "type": "string", "description": "URL path received in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine 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 }, "title": { "type": "string", "description": "title of the \u2018reviews\u2019 element in SERP\nthe name of the local establishment for which the reviews are collected", "nullable": true }, "location": { "type": "string", "description": "location of the local establishment\naddress of the local establishment for which the reviews are collected", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews", "format": "int64", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "rating of the corresponding local establishment\npopularity rate based on reviews and displayed in SERP", "nullable": true }, "rating_distribution": { "type": "object", "additionalProperties": { "type": "integer", "format": "Int64", "nullable": true }, "description": "rating distribution by votes\nthe distribution of votes across the rating in the range from 1 to 5", "nullable": true }, "items_count": { "type": "integer", "description": "the number of reviews items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TripadvisorReviewSearch" } ], "nullable": true }, "description": "found reviews\nyou can get more results by using the depth parameter when setting a task", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true } } }, "TripadvisorReviewSearch": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed reviews\nabsolute position among all reviews on the list", "nullable": true }, "position": { "type": "string", "description": "the alignment of the review in SERP\ncan take the following values: right", "nullable": true }, "url": { "type": "string", "description": "URL of the review", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the rating score submitted by the reviewer", "nullable": true }, "date_of_visit": { "type": "string", "description": "date of the reviewer\u2019s visit to the local establishment\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "timestamp": { "type": "string", "description": "date and time when the review was published\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "review_id": { "type": "string", "description": "ID of the review", "nullable": true }, "title": { "type": "string", "description": "title of the review", "nullable": true }, "review_text": { "type": "string", "description": "content of the review", "nullable": true }, "language": { "type": "string", "description": "language of the review text", "nullable": true }, "original_language": { "type": "string", "description": "language of the untranslated review text", "nullable": true }, "review_images": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ImageUrlInfo" } ], "nullable": true }, "description": "contains URLs of the images used in the review", "nullable": true }, "user_profile": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataUserProfileInfo" } ], "description": "information from the reviewer\u2019s profile", "nullable": true }, "responses": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ReviewResponseItemInfo" } ], "nullable": true }, "description": "contains information about the owner\u2019s response", "nullable": true }, "review_highlights": { "type": "object", "description": "review highlights\ncontains highlighted review criteria and assessments", "nullable": true } } }, "ImageUrlInfo": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the image used in the review", "nullable": true } } }, "BusinessDataUserProfileInfo": { "type": "object", "properties": { "name": { "type": "string", "description": "the name of the reviewer", "nullable": true }, "url": { "type": "string", "description": "URL to the reviewer\u2019s profile", "nullable": true }, "image_url": { "type": "string", "description": "URL to the reviewer\u2019s profile picture", "nullable": true }, "location": { "type": "string", "description": "country of the reviewer", "nullable": true }, "reviews_count": { "type": "integer", "description": "total number of reviews submitted by the reviewer", "format": "int64", "nullable": true } } }, "ReviewResponseItemInfo": { "type": "object", "properties": { "title": { "type": "string", "description": "the title of response", "nullable": true }, "text": { "type": "string", "description": "the content of response", "nullable": true }, "timestamp": { "type": "string", "description": "the time of publication", "nullable": true } } }, "BusinessDataGoogleMyBusinessUpdatesTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field\nthe keyword you specify should indicate the name of the local establishment\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d;this field can also be used to pass cid (unique, google-defined id of the business entity) or place_id (identifier of the business entity in Google Maps) parameters\nexample:\ncid:194604053573767737\nplace_id:GhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the cid and place_id identifiers in this help center article" }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "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 with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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\u201d format\nthe maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nthe minimum value for \u201cradius\u201d: 199.9\nexample:\n53.476225,-2.243572,200", "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 with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of updates in SERP\nwe strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row\nplease note that Google returns 4490 updates maximum\ndefault value: 10", "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 }, "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 } }, "example": [ { "language_code": "en", "location_name": "New York,New York,United States", "keyword": "RustyBrick, Inc." } ] }, "BusinessDataBusinessListingsSearchLiveRequestInfo": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "business categories\noptional field\nthe categories you specify are used to search for business listings;\nif you don\u2019t use this field, we will return business listings found in the specified location;\nyou can specify up to 10 categories", "nullable": true }, "description": { "type": "string", "description": "description of the element in SERP\noptional field\nthe description of the business entity for which the results are collected;\ncan contain up to 200 characters", "nullable": true }, "title": { "type": "string", "description": "title of the element in SERP\noptional field\nthe name of the business entity for which the results are collected;\ncan contain up to 200 characters", "nullable": true }, "is_claimed": { "type": "boolean", "description": "indicates whether the business is verified by its owner on Google Maps\noptional field", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude,radius\u201d format\nthe maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nthe value of \u201cradius\u201d is specified in kilometres (km)\nthe minimum value for \u201cradius\u201d: 1\nthe maximum value for \u201cradius\u201d: 100000\nexample:\n53.476225,-2.243572,200", "nullable": true }, "filters": { "type": "array", "items": { "type": "object", "nullable": true }, "description": "array of results filtering parameters\noptional field\nyou can add several filters at once (8 filters maximum)\nyou should set a logical operator and, or between the conditions\nthe following operators are supported:\nregex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match\nyou can use the % operator with like and not_like to match any string of zero or more characters\nexample:\n[\"rating.value\",\">\",3]\nyou can receive the list of available filters\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters\nThe full list of possible filters is available here.", "nullable": true }, "order_by": { "type": "array", "items": { "type": "string" }, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc \u2013 results will be sorted in the ascending order\ndesc \u2013 results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\nexample:\n[\"rating.value,desc\"]note that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"rating.value,desc\",\"rating.votes_count,desc\"]", "nullable": true }, "limit": { "type": "integer", "description": "the maximum number of returned businesses\noptional field\ndefault value: 100\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned businesses\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities\nNote: we recommend using this parameter only when retrieving up to 10,000 results\nfor retrieving over 10,000 results, use the offset_token instead", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\noptional field\nprovided in the identical filed of the response to each request;\nuse this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;\nby specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;\noffset_token values are unique for each subsequent task\nNote: if the offset_token is specified in the request, all other parameters should be identical to the previous request\nlearn more about this parameter 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": [ { "categories": [ "pizza_restaurant" ], "description": "pizza", "title": "pizza", "is_claimed": true, "location_coordinate": "53.476225,-2.243572,10", "order_by": [ "rating.value,desc" ], "filters": [ [ "rating.value", ">", 3 ] ], "limit": 3 } ] }, "BusinessDataGoogleHotelInfoTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoTasksReadyResultInfo": { "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\ncan take the following values: google", "nullable": true }, "se_type": { "type": "string", "description": "search engine specified when setting the task", "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 } } }, "BusinessDataGoogleLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleLanguagesResultInfo": { "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 } } }, "BusinessDataGoogleHotelInfoLiveHtmlResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoLiveHtmlTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoLiveHtmlResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "unique hotel identifier specified as \"hotel_id:$\"", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "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/HtmlItemInfo" } ], "nullable": true }, "description": "HTML pages", "nullable": true } } }, "HtmlItemInfo": { "type": "object", "properties": { "page": { "type": "integer", "description": "serial number of the returned HTML page", "nullable": true }, "date": { "type": "string", "description": "date and time when the HTML page was scanned\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "html": { "type": "string", "description": "HTML\u00a0page", "nullable": true } } }, "BusinessDataGoogleQuestionsAndAnswersLiveRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field\nthe keyword you specify should indicate the name of the local establishment\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d; \nthis field can also be used to pass the following parameters:\ncid \u2013 a unique, google-defined id of the business entity;\nplace_id \u2013 an identifier of the business entity in Google Maps;\nexample:\ncid:194604053573767737\nplace_id:GhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the cid and place_id identifiers in this help center 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 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 with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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\u201d format\nthe maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nthe minimum value for \u201cradius\u201d: 199.9 (mm)\nthe maximum value for \u201cradius\u201d: 199999 (mm)\nexample:\n53.476225,-2.243572,200", "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 with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of results in SERP\ndefault value: 20\nmax value: 100\nYour account will be billed per each SERP containing up to 20 results;\nSetting depth above 20 may result in additional charges if the search engine returns more than 20 results;\nIf the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;\nThe cost can be calculated on the Pricing page.", "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_name": "Los Angeles,California,United States", "keyword": "The Last Bookstore" } ] }, "BusinessDataTrustpilotSearchTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotSearchTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTrustpilotSearchTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataGoogleExtendedReviewsTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleExtendedReviewsTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleExtendedReviewsTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleExtendedReviewsTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleExtendedReviewsTasksReadyResultInfo": { "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\ncan take the following values: google", "nullable": true }, "se_type": { "type": "string", "description": "type of search engine", "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 } } }, "BusinessDataBusinessListingsAvailableFiltersResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsAvailableFiltersTaskInfo" } ], "nullable": true }, "nullable": true } } } ] }, "BusinessDataBusinessListingsAvailableFiltersTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsAvailableFiltersResultInfo" } ], "nullable": true }, "nullable": true } } } ] }, "BusinessDataBusinessListingsAvailableFiltersResultInfo": { "type": "object", "properties": { "search": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "categories_aggregation": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } } }, "BusinessDataGoogleExtendedReviewsTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field if you don\u2019t specify cid or place_id\nthe keyword you specify should indicate the name of the local establishment;\nyou can specify up to 700 characters in the keyword filed;\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d;\nif this field contains such parameters as \u2018allinanchor:\u2019, \u2018allintext:\u2019, \u2018allintitle:\u2019, \u2018allinurl:\u2019, \u2018define:\u2019, \u2018filetype:\u2019, \u2018id:\u2019, \u2018inanchor:\u2019, \u2018info:\u2019, \u2018intext:\u2019, \u2018intitle:\u2019, \u2018inurl:\u2019, \u2018link:\u2019, \u2018related:\u2019, \u2018site:\u2019, the charge per task will be multiplied by 5\nNote: queries containing the \u2018cache:\u2019 parameter are not supported and will return a validation error\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article\nNote: if you use this field, your account will be charged three times the standard rate for tasks involving the Google Reviews API", "nullable": true }, "cid": { "type": "string", "description": "unique, google-defined id of the business entity\nrequired field if you don\u2019t specify keyword or place_id\nexample:\n194604053573767737\nlearn more about the identifier in this help center article\nNote: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API", "nullable": true }, "place_id": { "type": "string", "description": "identifier of the business entity in Google Maps\nrequired field if you don\u2019t specify keyword or cid\nexample:\nGhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the identifier in this help center article\nNote: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "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 with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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\u201d format\nthe maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nthe minimum value for \u201cradius\u201d: 199.9\nexample:\n53.476225,-2.243572,200", "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 with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of reviews in SERP\nwe strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row\ndefault value: 20\nmaximum value: 1000\nYour account will be billed per each SERP containing up to 20 results;\nSetting depth above 20 may result in additional charges if the search engine returns more than 20 results;\nThe cost can be calculated on the Pricing page.", "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 }, "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 } }, "example": [ { "location_name": "London,England,United Kingdom", "language_name": "english", "cid": "17626775537598922320" } ] }, "BusinessDataSocialMediaRedditLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataSocialMediaRedditLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataSocialMediaRedditLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataSocialMediaRedditLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataSocialMediaRedditLiveResultInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "page_url": { "type": "string", "description": "URL of the page the data is provided for\ncorresponding URL you specified in the targets array when setting a task", "nullable": true }, "reddit_reviews": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RedditReviews" } ], "nullable": true }, "description": "reddit reviews for the page_url", "nullable": true } } }, "RedditReviews": { "type": "object", "properties": { "subreddit": { "type": "string", "description": "the name of the subreddit", "nullable": true }, "author_name": { "type": "string", "description": "nickname of the author\nnicknname of the user who published the post in the subreddit and shared the URL", "nullable": true }, "title": { "type": "string", "description": "title of the subreddit post", "nullable": true }, "permalink": { "type": "string", "description": "URL to the subreddit post", "nullable": true }, "subreddit_members": { "type": "integer", "description": "number of subreddit members", "nullable": true } } }, "BusinessDataTrustpilotReviewsTaskPostRequestInfo": { "type": "object", "properties": { "domain": { "type": "string", "description": "domain of the local establishment\nrequired field\ndomain of the local establishment on Trustpilot;\nyou can find the domain in the URL of every business listed on Trustpilot\nexample:\nwww.thepearlsource.com\nhttps://www.trustpilot.com/review/www.thepearlsource.com" }, "sort_by": { "type": "string", "description": "results sorting parameter\noptional field\nyou can use this field to sort the results;\npossible sorting parameters:\nrecency \u2014 most recent reviews first;\nrelevance \u2014 most relevant reviews first;\ndefault value: relevance", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of reviews to be returned from the API response\nwe strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row\ndefault value: 20\nmaximum value: 200\nYour account will be billed per each SERP containing up to 20 results;\nSetting depth above 20 may result in additional charges if the search engine returns more than 20 results;\nThe cost can be calculated on the Pricing page.", "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 }, "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 } }, "example": [ { "domain": "www.thepearlsource.com", "depth": 40 } ] }, "BusinessDataTripadvisorSearchTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field\nthe keyword you specify should indicate a business category, company name, or a prominent place;\nyou can specify up to 700 characters in the keyword filed;\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character);\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d\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 the https://api.dataforseo.com/v3/business_data/tripadvisor/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\nyou can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations\nexample:\n1003854", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of search results to be returned from the API response\nwe strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;\ndefault value: 30;\nmaximum value: 210\nYour account will be billed per each SERP containing up to 30 results;\nSetting depth above 30 may result in additional charges if the search engine returns more than 30 results;\nThe cost can be calculated on the Pricing page.", "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 }, "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 } }, "example": [ { "keyword": "pizza", "location_code": 1003854, "depth": 30 } ] }, "BusinessDataTrustpilotSearchTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotSearchTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTrustpilotSearchTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotSearchTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTrustpilotSearchTasksReadyResultInfo": { "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\ncan take the following values: trustpilot", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "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 } } }, "BusinessDataSocialMediaPinterestLiveRequestInfo": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "string" }, "description": "target URLs\nrequired field\ntarget page should be specified with its absolute URL (including http:// or https://)\nexample:\nhttps://dataforseo.com/\nNote: you can specify 10 targets maximum. You will be charged per earch URL you specify in this array" }, "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": [ { "targets": [ "https://www.simplyrecipes.com/recipes/grilled_salmon_with_cucumber_mango_salsa/", "https://tasty.co/recipe/classic-lasagna", "https://www.allrecipes.com/recipe/255263/sicilian-roasted-chicken/" ], "tag": "some_string_123" } ] }, "BusinessDataBusinessListingsCategoriesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsCategoriesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataBusinessListingsCategoriesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataBusinessListingsCategoriesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataBusinessListingsCategoriesResultInfo": { "type": "object", "properties": { "category_name": { "type": "string", "description": "full name of the category", "nullable": true }, "business_count": { "type": "integer", "description": "number of businesses in the category", "format": "int64", "nullable": true } } }, "BusinessDataTripadvisorSearchTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorSearchTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTripadvisorSearchTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorSearchTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTripadvisorSearchTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST array\nthis field will contain the alias parameter if it was specified in a POST array", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to Tripadvisor 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 }, "item_types": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "item types encountered in the result\npossible item types: tripadvisor_search_organic", "nullable": true }, "se_results_count": { "type": "integer", "description": "the total number of results", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TripadvisorSearchOrganic" } ], "nullable": true }, "description": "Tripadvisor search listing results\nyou can get more results by using the depth parameter when setting a task", "nullable": true } } }, "TripadvisorSearchOrganic": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed results\nabsolute position among all reviews on the list", "nullable": true }, "title": { "type": "string", "description": "name of the business entity", "nullable": true }, "url_path": { "type": "string", "description": "URL path of the business entity\nURL path to the Tripadvisor page of the business entity\nyou can use this identifier to collect reviews for the business entity using Tripadvisor Reviews", "nullable": true }, "is_sponsored": { "type": "boolean", "description": "indicates a sponsored placement\nif true, related tripadvisor_search_organic item is a paid advertising on Tripadvisor", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews", "format": "int64", "nullable": true }, "category": { "type": "string", "description": "place category", "nullable": true }, "price_rate": { "type": "string", "description": "average price rate", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the rating score of the establishment submitted by the reviewers", "nullable": true } } }, "BusinessDataErrorsRequestInfo": { "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: hotel_searches/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" } ] }, "BusinessDataGoogleHotelInfoTaskGetHtmlResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoTaskGetHtmlTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoTaskGetHtmlTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoTaskGetHtmlResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoTaskGetHtmlResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "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 }, "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/HtmlItemInfo" } ], "nullable": true }, "description": "HTML pages", "nullable": true } } }, "BusinessDataIdListResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataIdListTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataIdListTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataIdListResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataIdListResultInfo": { "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": "array", "items": { "type": "string", "nullable": true }, "description": "contains parameters you specified in the POST request", "nullable": true } } }, "BusinessDataGoogleExtendedReviewsTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleExtendedReviewsTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleExtendedReviewsTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataTrustpilotReviewsTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotReviewsTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTrustpilotReviewsTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotReviewsTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTrustpilotReviewsTaskGetResultInfo": { "type": "object", "properties": { "domain": { "type": "string", "description": "domain of the business entity", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine 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 }, "title": { "type": "string", "description": "title of the \u2018reviews\u2019 element on Trustpilot\nthe name of the business entity for which the reviews are collected", "nullable": true }, "location": { "type": "string", "description": "location of the business entity as specified on Trustpilot\naddress of the business entity for which the reviews are collected", "nullable": true }, "reviews_count": { "type": "string", "description": "the total number of reviews", "format": "int64", "nullable": true }, "rating": { "type": "object", "description": "rating of the corresponding business entity\npopularity rate based on reviews and displayed in SERP", "nullable": true }, "items_count": { "type": "integer", "description": "the number of items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TrustpilotReviewSearch" } ], "nullable": true }, "description": "found reviews\nyou can get more results by using the depth parameter when setting a task", "nullable": true } } }, "TrustpilotReviewSearch": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed reviews\nabsolute position among all reviews on the list", "nullable": true }, "position": { "type": "string", "description": "the alignment of the review in SERP\ncan take the following values: right", "nullable": true }, "url": { "type": "string", "description": "the URL of the review", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the rating score submitted by the reviewer", "nullable": true }, "verified": { "type": "boolean", "description": "indicates whether the review has the \u201cVerified\u201d mark", "nullable": true }, "language": { "type": "string", "description": "the language of the review", "nullable": true }, "timestamp": { "type": "string", "description": "date and time when a review was published\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "title": { "type": "string", "description": "the title of the review", "nullable": true }, "review_text": { "type": "string", "description": "the content of the review", "nullable": true }, "review_images": { "type": "array", "items": { "type": "string" }, "description": "images submitted by the reviewer\ndisplays URLs to the images provided by the author of the review;\nplease note that Trustpilot doesn\u2019t allow adding images to reviews, so the review_images parameter will always equal null", "nullable": true }, "user_profile": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataUserProfileInfo" } ], "description": "user profile of the reviewer", "nullable": true }, "responses": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ReviewResponseItemInfo" } ], "nullable": true }, "description": "owner\u2019s response to the submitted review", "nullable": true } } }, "BusinessDataTripadvisorReviewsTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorReviewsTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTripadvisorReviewsTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorReviewsTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTripadvisorReviewsTasksReadyResultInfo": { "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\ncan take the following values: tripadvisor", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "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 } } }, "BusinessDataGoogleHotelSearchesLiveRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\noptional field\nthe keyword you specify is used to search for the list of hotels;\nif you don\u2019t use this field, we will return the list of hotels found in a specified location;\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d;\nNote: in order to obtain accurate search results, the location name is appended to the keyword automatically\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", "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 with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations\nexample:\nLondon,England,United Kingdom\nNote: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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 maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nNote: if the coordinates are used to set a location, the search will occur in the nearest settlement\nexample:\n53.476225,-2.243572", "nullable": true }, "search_this_area": { "type": "boolean", "description": "show hotels from the displayed area\noptional field\ncan take the values: true, false\ndefault value: true\nif set to false the search_this_area mode will be turned off\nNote: if the search_this_area mode is turned off, the location_name won\u2019t be appended to the keyword during search\nlearn more about this parameter on our Help Center", "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 with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of results in Google Hotels\ndefault value: 20 organic results\nmax value: 140\nNote: your account will be billed per each 20 organic results regardless of paid listings in the response;\nthus, setting a depth above 20 may result in additional charges if Google Hotels return more than 20 results;\nif the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", "nullable": true }, "check_in": { "type": "string", "description": "check-in date\noptional field\nif you don\u2019t specify this field, tomorrow\u2019s date will be used by default;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"\nNote: the value cannot precede the today\u2019s date", "nullable": true }, "check_out": { "type": "string", "description": "check-out date\noptional field\nif you don\u2019t specify this field, our system will apply the date of two days from now by default;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"\nNote: the value cannot be less than or equal to check_in;\nthe range between check_in and check_out values cannot exceed 30 days", "nullable": true }, "currency": { "type": "string", "description": "currency\noptional field\nexample:\n\"USD\"", "nullable": true }, "adults": { "type": "integer", "description": "number of adults\noptional field\nif you don\u2019t specify this field, the default value of 2 will be applied;\nnote that you can specify up to 6 persons including both adults and children\nexample:\n1", "nullable": true }, "children": { "type": "array", "items": { "type": "string" }, "description": "number and age of children\noptional field\nif you don\u2019t specify this field, no children will be included in the search;\nage of child can be from 0 to 17;\nnote that you can specify up to 6 persons including both adults and children\nset the following value if you want to include one 14-year-old child:\n[14]\nset the following value if you want to include one 13-year-old child and one 8-year-old child:\n[13,8]", "nullable": true }, "stars": { "type": "array", "items": { "type": "string" }, "description": "hotel stars\noptional field\nset this field to [5] if you want to get the list of 5-star hotels only\nexample:\n[3,4,5]", "nullable": true }, "min_rating": { "type": "number", "description": "minimum rating\noptional field\nyou can use this field to specify guest rating higher than a certain value\nexample:\n2.5", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nyou can use this field to sort the results\npossible types of sorting:\nrelevance \u2013 sort by most relevant\nlowest_price \u2013 sort by the lowest price\nhighest_rating \u2013 sort by highest rating\nmost_reviewed \u2013 sort by most reviewed\ndefault value: relevance", "nullable": true }, "min_price": { "type": "integer", "description": "minimum price per night\noptional field\nthe currency of this value depends on the currency field\nexample:\n100", "nullable": true }, "max_price": { "type": "integer", "description": "maximum price per night\noptional field\nthe currency of this value depends on the currency field\nexample:\n600", "nullable": true }, "free_cancellation": { "type": "boolean", "description": "hotels with a free cancellation\noptional field\nset this field to true if you want to get the list of hotels with free cancellation of reservations\ndefault value: false", "nullable": true }, "is_vacation_rentals": { "type": "boolean", "description": "search for vacation rentals\noptional field\nset this field to true if you want to get the list of vacation rentals instead of hotels\ndefault value: false", "nullable": true }, "amenities": { "type": "array", "items": { "type": "string" }, "description": "hotel amenities\noptional field\nyou can use this field to specify different hotel amenities\nexample:\n [\n \"free_parking\",\n \"pets_allowed\"\n ]\n\npossible values:\n\"air_conditioning\",\n\"all_inclusive_available\",\n\"bar\",\n\"free_breakfast\",\n\"fitness_center\",\n\"kid_friendly\",\n\"free_parking\",\n\"pets_allowed\",\n\"pool\",\n\"restaurant\",\n\"room_service\",\n\"spa\",\n\"free_wifi\",\n\"parking\",\n\"indoor_pool\",\n\"outdoor_pool\",\n\"wheelchair_accessible\",\n\"beach_access\"", "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_name": "New York,New York,United States", "keyword": "cheap hotel", "check_in": "2026-05-15", "check_out": "2026-05-16", "currency": "USD", "adults": 2, "children": [ 14 ], "sort_by": "highest_rating", "tag": "example" } ] }, "BusinessDataGoogleMyBusinessUpdatesTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessUpdatesTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessUpdatesTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST array\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character)\nthis field will contain the cid parameter if you specified it in the keyword field when setting a task;\nexample:\ncid:2946633002421908862\nlearn more about the parameter in this help center article", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain as specified in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\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 }, "business_updates_id": { "type": "string", "description": "identifier of the business updates element in SERP", "nullable": true }, "cid": { "type": "string", "description": "google-defined client id\nunique id of a local establishment\nlearn more about the cid identifier in this help center article", "nullable": true }, "feature_id": { "type": "string", "description": "the unique identifier of the element in SERP\nlearn more about the identifier in this help center article", "nullable": true }, "item_types": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "item types\ntypes of search engine results encountered in the items array;\npossible item types: google_business_post", "nullable": true }, "items_count": { "type": "integer", "description": "item types\nthe number of items in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GoogleBusinessPost" } ], "nullable": true }, "description": "encountered item types\ntypes of search engine results encountered in the items array;\npossible item types: google_business_post", "nullable": true } } }, "GoogleBusinessPost": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed updates\nabsolute position among all present elements", "nullable": true }, "position": { "type": "string", "description": "the alignment of the element in SERP\ncan take the following values: right", "nullable": true }, "xpath": { "type": "string", "description": "the XPath of the element", "nullable": true }, "author": { "type": "string", "description": "author of the post", "nullable": true }, "snippet": { "type": "string", "description": "additional content of a post", "nullable": true }, "post_text": { "type": "string", "description": "main content of a post", "nullable": true }, "url": { "type": "string", "description": "url of a post", "nullable": true }, "images_url": { "type": "string", "description": "url of an image included in the post", "nullable": true }, "post_date": { "type": "string", "description": "date when a post was published\nin the following format:\n\"mm/dd/yyyy hh:mm:ss\"", "nullable": true }, "timestamp": { "type": "string", "description": "time when a post was published\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "links": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/LinkElement" } ], "nullable": true }, "description": "links included in the post", "nullable": true } } }, "LinkElement": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "title": { "type": "string", "description": "title of a given link element", "nullable": true }, "snippet": { "type": "string", "description": "text alongside the link title", "nullable": true }, "description": { "type": "string", "description": "description of the results element", "nullable": true }, "url": { "type": "string", "description": "URL", "nullable": true }, "domain": { "type": "string", "description": "domain where a link points", "nullable": true }, "xpath": { "type": "string", "description": "the XPath of the element", "nullable": true } } }, "BusinessDataTripadvisorLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTripadvisorLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTripadvisorLocationsResultInfo": { "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_name_parent": { "type": "string", "description": "the name of the superordinate location\nexample:\n\"location_code\": 9041134,\n\"location_name\": \"Vienna International Airport,Lower Austria,Austria\",\n\"location_name_parent\": \"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 } } }, "BusinessDataGoogleMyBusinessInfoLiveRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field\nthe keyword you specify should indicate the name of the local establishment\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d; \nthis field can also be used to pass the following parameters:\ncid \u2013 a unique, google-defined id of the business entity;\nplace_id \u2013 an identifier of the business entity in Google Maps;\nexample:\ncid:194604053573767737\nplace_id:GhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the cid and place_id identifiers in this help center 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 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 with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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\u201d format\nthe maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nthe minimum value for \u201cradius\u201d: 199.9 (mm)\nthe maximum value for \u201cradius\u201d: 199999 (mm)\nexample:\n53.476225,-2.243572,200", "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 with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "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_name": "New York,New York,United States", "keyword": "RustyBrick, Inc." } ] }, "BusinessDataIdListRequestInfo": { "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 } ] }, "BusinessDataGoogleHotelSearchesLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelSearchesLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelSearchesLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelSearchesLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleHotelSearchesLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST array\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character)", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine 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": "item types\nthe number of items in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelSearchesItem" } ], "nullable": true }, "description": "array of items\nnote: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint", "nullable": true } } }, "BusinessDataGoogleHotelSearchesTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\noptional field\nthe keyword you specify is used to search for the list of hotels;\nif you don\u2019t use this field, we will return the list of hotels found in a specified location;\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d;\nNote: in order to obtain accurate search results, the location name is appended to the keyword automatically\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "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 with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations\nexample:\nLondon,England,United Kingdom\nNote: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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 maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nNote: if the coordinates are used to set a location, the search will occur in the nearest settlement;\nexample:\n53.476225,-2.243572", "nullable": true }, "search_this_area": { "type": "boolean", "description": "show hotels from the displayed area\noptional field\ncan take the values: true, false\ndefault value: true\nif set to false the search_this_area mode will be turned off\nNote: if the search_this_area mode is turned off, the location_name won\u2019t be appended to the keyword during search\nlearn more about this parameter on our Help Center", "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 with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of results in Google Hotels\ndefault value: 20 organic results\nmax value: 140\nNote: your account will be billed per each 20 organic results regardless of paid listings in the response;\nthus, setting a depth above 20 may result in additional charges if Google Hotels return more than 20 results;\nif the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance", "nullable": true }, "check_in": { "type": "string", "description": "check-in date\noptional field\nif you don\u2019t specify this field, tomorrow\u2019s date will be used by default;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"\nNote: the value cannot precede the today\u2019s date", "nullable": true }, "check_out": { "type": "string", "description": "check-out date\noptional field\nif you don\u2019t specify this field, our system will apply the date of two days from now by default;\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"\nNote: the value cannot be less than or equal to check_in;\nthe range between check_in and check_out values cannot exceed 30 days", "nullable": true }, "currency": { "type": "string", "description": "currency\noptional field\nexample:\n\"USD\"", "nullable": true }, "adults": { "type": "integer", "description": "number of adults\noptional field\nif you don\u2019t specify this field, the default value of 2 will be applied;\nnote that you can specify up to 6 persons including both adults and children\nexample:\n1", "nullable": true }, "children": { "type": "array", "items": { "type": "string" }, "description": "number and age of children\noptional field\nif you don\u2019t specify this field, no children will be included in the search;\nage of child can be from 0 to 17;\nnote that you can specify up to 6 persons including both adults and children\nset the following value if you want to include one 14-year-old child:\n[14]\nset the following value if you want to include one 13-year-old child and one 8-year-old child:\n[13,8]", "nullable": true }, "stars": { "type": "array", "items": { "type": "string" }, "description": "hotel stars\noptional field\nset this field to [5] if you want to get the list of 5-star hotels only\nexample:\n[3,4,5]", "nullable": true }, "min_rating": { "type": "number", "description": "minimum rating\noptional field\nyou can use this field to specify guest rating higher than a certain value\nexample:\n2.5", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nyou can use this field to sort the results\npossible types of sorting:\nrelevance \u2013 sort by most relevant\nlowest_price \u2013 sort by the lowest price\nhighest_rating \u2013 sort by highest rating\nmost_reviewed \u2013 sort by most reviewed\ndefault value: relevance", "nullable": true }, "min_price": { "type": "integer", "description": "minimum price per night\noptional field\nthe currency of this value depends on the currency field\nexample:\n100", "nullable": true }, "max_price": { "type": "integer", "description": "maximum price per night\noptional field\nthe currency of this value depends on the currency field\nexample:\n600", "nullable": true }, "free_cancellation": { "type": "boolean", "description": "hotels with a free cancellation\noptional field\nset this field to true if you want to get the list of hotels with free cancellation of reservations\ndefault value: false", "nullable": true }, "is_vacation_rentals": { "type": "boolean", "description": "search for vacation rentals\noptional field\nset this field to true if you want to get the list of vacation rentals instead of hotels\ndefault value: false", "nullable": true }, "amenities": { "type": "array", "items": { "type": "string" }, "description": "hotel amenities\noptional field\nyou can use this field to specify different hotel amenities\nexample:\n [\n \"free_parking\",\n \"pets_allowed\"\n ]\n\npossible values:\n\"air_conditioning\",\n\"all_inclusive_available\",\n\"bar\",\n\"free_breakfast\",\n\"fitness_center\",\n\"kid_friendly\",\n\"free_parking\",\n\"pets_allowed\",\n\"pool\",\n\"restaurant\",\n\"room_service\",\n\"spa\",\n\"free_wifi\",\n\"parking\",\n\"indoor_pool\",\n\"outdoor_pool\",\n\"wheelchair_accessible\",\n\"beach_access\"", "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 }, "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 } }, "example": [ { "language_code": "en", "location_name": "New York,New York,United States", "keyword": "cheap hotel", "check_in": "2026-05-15", "check_out": "2026-05-16", "currency": "USD", "adults": 2, "children": [ 14 ], "sort_by": "highest_rating", "priority": 2, "tag": "example" } ] }, "BusinessDataGoogleReviewsTaskGetResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleReviewsTaskGetTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleReviewsTaskGetTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleReviewsTaskGetResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleReviewsTaskGetResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST array\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character)", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\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 }, "title": { "type": "string", "description": "title of the \u2018reviews\u2019 element in SERP\nthe name of the local establishment for which the reviews are collected", "nullable": true }, "sub_title": { "type": "string", "description": "subtitle of the \u2018reviews\u2019 element in SERP\nadditional information (e.g., address) on the \u2018reviews\u2019 element for which the reviews are collected", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "rating of the corresponding local establishment\npopularity rate based on reviews and displayed in SERP", "nullable": true }, "feature_id": { "type": "string", "description": "the unique identifier of the \u2018reviews\u2019 element in SERP\nlearn more about the identifier in this help center article", "nullable": true }, "place_id": { "type": "string", "description": "unique identifier of a business location assigned by Google\nlearn more about the identifier in this help center article", "nullable": true }, "cid": { "type": "string", "description": "google-defined client id\nunique id of a local establishment\nlearn more about the identifier in this help center article", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of reviews items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GoogleReviewsSearch" } ], "nullable": true }, "description": "found reviews\nyou can get more results by using the depth parameter when setting a task", "nullable": true } } }, "GoogleReviewsSearch": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed reviews\nabsolute position among all reviews on the list", "nullable": true }, "position": { "type": "string", "description": "the alignment of the review in SERP\ncan take the following values: right", "nullable": true }, "xpath": { "type": "string", "description": "the XPath of the review", "nullable": true }, "review_text": { "type": "string", "description": "the content of the review", "nullable": true }, "original_review_text": { "type": "string", "description": "original content of the review\nthe original content of the review, no auto-translate applied", "nullable": true }, "original_language": { "type": "string", "description": "original language of the review text", "nullable": true }, "time_ago": { "type": "string", "description": "the time of publication\nindicates the time (in the \u2018time ago\u2019 format) when the review was listed", "nullable": true }, "timestamp": { "type": "string", "description": "date and time when a review was published\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the rating score submitted by the reviewer", "nullable": true }, "reviews_count": { "type": "integer", "description": "total number of reviews submitted by the reviewer", "format": "int64", "nullable": true }, "photos_count": { "type": "integer", "description": "total number of photos submitted by the reviewer", "format": "int64", "nullable": true }, "local_guide": { "type": "boolean", "description": "indicates whether the reviewer has a \u2018local guide\u2019 status", "nullable": true }, "profile_name": { "type": "string", "description": "profile name of the reviewer", "nullable": true }, "profile_url": { "type": "string", "description": "URL of the reviewer\u2019s profile", "nullable": true }, "review_url": { "type": "string", "description": "the URL of the review", "nullable": true }, "profile_image_url": { "type": "string", "description": "URL of the reviewer\u2019s profile image", "nullable": true }, "owner_answer": { "type": "string", "description": "text of the owner\u2019s response\nthe owner\u2019s response to the review", "nullable": true }, "original_owner_answer": { "type": "string", "description": "original text of the owner\u2019s response\nthe original response to the review, no auto-translate applied", "nullable": true }, "owner_time_ago": { "type": "string", "description": "publication time\nindicates the time (in the \u2018time ago\u2019 format) when the owner submitted the response to the review", "nullable": true }, "owner_timestamp": { "type": "string", "description": "date and time of the owner\u2019s reply to the review\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "review_id": { "type": "string", "description": "the unique identifier of a review on Google\nexample:\nChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE", "nullable": true }, "images": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AiModeImagesElementInfo" } ], "nullable": true }, "description": "images submitted by the reviewer", "nullable": true }, "review_highlights": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ReviewHighlights" } ], "nullable": true }, "description": "review highlights\ncontains highlighted review criteria and assessments", "nullable": true } } }, "BusinessDataBusinessListingsCategoriesAggregationLiveRequestInfo": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "business categories\noptional field\nthe categories you specify are used to search for business listings;\nif you don\u2019t use this field, we will return business listings found in the specified location;\nyou can specify up to 10 categories", "nullable": true }, "description": { "type": "string", "description": "description of the element in SERP\noptional field\nthe description of the business entity for which the results are collected;\ncan contain up to 200 characters", "nullable": true }, "title": { "type": "string", "description": "title of the element in SERP\noptional field\nthe name of the business entity for which the results are collected;\ncan contain up to 200 characters", "nullable": true }, "is_claimed": { "type": "boolean", "description": "indicates whether the business is verified by its owner on Google Maps\noptional field", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\noptional field\nlocation_coordinate parameter should be specified in the \u201clatitude,longitude,radius\u201d format\nthe maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nthe minimum value for \u201cradius\u201d: 1\nthe maximum value for \u201cradius\u201d: 100000\nexample:\n53.476225,-2.243572,200", "nullable": true }, "initial_dataset_filters": { "type": "array", "items": { "type": "object", "nullable": true }, "description": "array of results filtering parameters\noptional field\nyou can add several filters at once (8 filters maximum)\nyou should set a logical operator and, or between the conditions\nthe following operators are supported:\nregex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, match, not_match\nyou can use the % operator with like and not_like to match any string of zero or more characters\nexample:\n[\"rating.value\",\">\",3]\nyou can receive the list of available filters\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters\nThe full list of possible filters is available here.", "nullable": true }, "internal_list_limit": { "type": "integer", "description": "maximum number of elements within internal arrays\noptional field\nyou can use this field to limit the number of elements within the aggregated categories\ndefault value: 10", "nullable": true }, "limit": { "type": "integer", "description": "the maximum number of returned businesses\noptional field\ndefault value: 100\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "the maximum number of returned businesses\noptional 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": [ { "categories": [ "pizza_restaurant" ], "description": "pizza", "title": "pizza", "is_claimed": true, "location_coordinate": "53.476225,-2.243572,10", "initial_dataset_filters": [ [ "rating.value", ">", 3 ] ], "limit": 3 } ] }, "BusinessDataTripadvisorReviewsTaskPostRequestInfo": { "type": "object", "properties": { "url_path": { "type": "string", "description": "URL path of the business entity\nrequired field if you do not specify keyword\nURL path to the Tripadvisor page of the business entity;\nexamples:\nHotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html\nhttps://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html", "nullable": true }, "keyword": { "type": "string", "description": "keyword\nrequired field if you do not specify url_path\nthe keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;\nyou can specify up to 700 characters in the keyword filed;\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character);\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d", "nullable": true }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code or url_path\nyou can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/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 url_path\nyou can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations\nexample:\n1003854", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nif you use this field, your account will be charged for one extra request\nyou can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languages\nexample:\nEnglish\nYou will be additionally charged for setting a language parameter in this endpoint.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nif you use this field, your account will be charged for one extra request\nyou can receive the list of available languages with language_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languages\nexample:\nen\nYou will be additionally charged for setting a language parameter in this endpoint.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of reviews in SERP;\nwe strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;\ndefault value: 10;\nmax value: 4490\nYour account will be billed per each SERP containing up to 10 results;\nSetting depth above 10 may result in additional charges if the search engine returns more than 10 results;\nThe cost can be calculated on the Pricing page.", "nullable": true }, "ratings": { "type": "array", "items": { "type": "string" }, "description": "Tripadvisor traveler rating for a place of interest\noptional field\nrating based on the written reviews by a traveler after they visited a place.\npossible values: excellent, very_good, average, poor, terrible\nyou can specify several values at once", "nullable": true }, "visit_type": { "type": "array", "items": { "type": "string" }, "description": "filter by type of travelers who left a review\noptional field\npossible values: families, couples, solo, business, friends\nyou can specify several values at once", "nullable": true }, "months": { "type": "array", "items": { "type": "string" }, "description": "filter by months when a traveler made a visit\noptional field\npossible values: january, february, march, april, may, april, june, july, august, september, october, november, december\nyou can specify several values at once", "nullable": true }, "search_reviews_keyword": { "type": "string", "description": "search reviews containing a specified keyword\nexample:\ndessert", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nyou can use this field to sort the results;\npossible types of sorting:\nmost_recent\ndetailed_reviews", "nullable": true }, "translate_reviews": { "type": "boolean", "description": "translate reviews according to the URL path\noptional field\nif set to true, returned reviews will be translated to the language matching the specified url_path;\nfor example, if url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language;\ndefault value: true\nyou can learn more about how reviews are translated in this Help Center article", "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 }, "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 } }, "example": [ { "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html", "location_code": 1003854, "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag", "tag": "some_string_123" } ] }, "BusinessDataErrorsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataErrorsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataErrorsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataErrorsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataErrorsResultInfo": { "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 } } }, "BusinessDataTrustpilotReviewsTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotReviewsTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTrustpilotReviewsTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTrustpilotReviewsTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTrustpilotReviewsTasksReadyResultInfo": { "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\ncan take the following values: trustpilot", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "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 } } }, "BusinessDataGoogleReviewsTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field if you don\u2019t specify cid or place_id\nthe keyword you specify should indicate the name of the local establishment;\nyou can specify up to 700 characters in the keyword filed;\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d;\nif this field contains such parameters as \u2018allinanchor:\u2019, \u2018allintext:\u2019, \u2018allintitle:\u2019, \u2018allinurl:\u2019, \u2018define:\u2019, \u2018filetype:\u2019, \u2018id:\u2019, \u2018inanchor:\u2019, \u2018info:\u2019, \u2018intext:\u2019, \u2018intitle:\u2019, \u2018inurl:\u2019, \u2018link:\u2019, \u2018related:\u2019, \u2018site:\u2019, the charge per task will be multiplied by 5\nNote: queries containing the \u2018cache:\u2019 parameter are not supported and will return a validation error\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", "nullable": true }, "cid": { "type": "string", "description": "unique, google-defined id of the business entity\nrequired field if you don\u2019t specify keyword or place_id\nexample:\n194604053573767737\nlearn more about the identifier in this help center article", "nullable": true }, "place_id": { "type": "string", "description": "identifier of the business entity in Google Maps\nrequired field if you don\u2019t specify keyword or cid\nexample:\nGhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the identifier in this help center article", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "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 with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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\u201d format\nthe maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nthe minimum value for \u201cradius\u201d: 199.9\nexample:\n53.476225,-2.243572,200", "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 with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of reviews in SERP\nwe strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row\ndefault value: 10\nmaximum value: 4490\nYour account will be billed per each SERP containing up to 10 results;\nSetting depth above 10 may result in additional charges if the search engine returns more than 10 results;\nThe cost can be calculated on the Pricing page.", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nyou can use this field to sort the results\npossible types of sorting:\nnewest \u2013 sort by newest first\nhighest_rating \u2013 sort by highest rating\nlowest_rating \u2013 sort by lowest rating\nrelevant \u2013 sort by relevance\ndefault value: relevant", "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 }, "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 } }, "example": [ { "location_name": "London,England,United Kingdom", "language_name": "English", "keyword": "hedonism wines", "depth": 50, "sort_by": "highest_rating" } ] }, "BusinessDataGoogleMyBusinessInfoTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field\nthe keyword you specify should indicate the name of the local establishment\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d; \nthis field can also be used to pass the following parameters:\ncid \u2013 a unique, google-defined id of the business entity;\nplace_id \u2013 an identifier of the business entity in Google Maps;\nexample:\ncid:194604053573767737\nplace_id:GhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the cid and place_id identifiers in this help center article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "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 with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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\u201d format\nthe maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nthe minimum value for \u201cradius\u201d: 199.9 (mm)\nthe maximum value for \u201cradius\u201d: 199999 (mm)\nexample:\n53.476225,-2.243572,200", "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 with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "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 }, "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 } }, "example": [ { "language_code": "en", "location_name": "New York,New York,United States", "keyword": "RustyBrick, Inc." } ] }, "BusinessDataGoogleMyBusinessInfoTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessInfoTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessInfoTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessInfoTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessInfoTasksReadyResultInfo": { "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\ncan take the following values: google", "nullable": true }, "se_type": { "type": "string", "description": "search engine specified when setting the task", "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 } } }, "BusinessDataTripadvisorSearchTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorSearchTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataTripadvisorSearchTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataTripadvisorSearchTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataTripadvisorSearchTasksReadyResultInfo": { "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\ncan take the following values: tripadvisor", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "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 } } }, "BusinessDataGoogleMyBusinessInfoTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessInfoTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataGoogleReviewsTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleReviewsTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleReviewsTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleReviewsTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleReviewsTasksReadyResultInfo": { "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\ncan take the following values: google", "nullable": true }, "se_type": { "type": "string", "description": "type of search engine", "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 } } }, "BusinessDataGoogleMyBusinessInfoLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessInfoLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessInfoLiveResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST array\nkeyword is returned with decoded %## (plus character \u2018+\u2019 will be decoded to a space character)\nthis field will contain the cid parameter if you specified it in the keyword field when setting a task;\nexample:\ncid:2946633002421908862\nlearn more about the parameter in this help center article", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain as specified in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\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 }, "item_types": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "item types\ntypes of search engine results encountered in the items array;\npossible item types: google_business_info", "nullable": true }, "items_count": { "type": "integer", "description": "item types\nthe number of items in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ItemsGoogleBusinessInfo" } ], "nullable": true }, "description": "encountered item types\ntypes of search engine results encountered in the items array;\npossible item types: google_business_info", "nullable": true } } }, "ItemsGoogleBusinessInfo": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the elements", "nullable": true }, "position": { "type": "string", "description": "the alignment in SERP", "nullable": true }, "title": { "type": "string", "description": "title of the element in SERP\nthe name of the business entity for which the results are collected", "nullable": true }, "original_title": { "type": "string", "description": "original title of the element\noriginal title not translated by Google", "nullable": true }, "description": { "type": "string", "description": "description of the element in SERP\nthe description of the business entity for which the results are collected", "nullable": true }, "category": { "type": "string", "description": "business category\nGoogle My Business general category that best describes the services provided by the business entity", "nullable": true }, "category_ids": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "global category IDs\nuniversal category IDs that do not change based on the selected country", "nullable": true }, "additional_categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "additional business categories\nadditional Google My Business categories that describe the services provided by the business entity in more detail", "nullable": true }, "cid": { "type": "string", "description": "google-defined client id\nunique id of a local establishment;\ncan be used with Google Reviews API to get a full list of reviews\nlearn more about the identifier in this help center article", "nullable": true }, "feature_id": { "type": "string", "description": "the unique identifier of the element in SERP\nlearn more about the identifier in this help center article", "nullable": true }, "address": { "type": "string", "description": "address of the business entity", "nullable": true }, "address_info": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AddressInfo" } ], "description": "object containing address components of the business entity", "nullable": true }, "place_id": { "type": "string", "description": "unique place identifier\nplace id of the local establishment featured in the element\nlearn more about the identifier in this help center article", "nullable": true }, "phone": { "type": "string", "description": "phone number of the business entity", "nullable": true }, "url": { "type": "string", "description": "absolute url of the business entity", "nullable": true }, "contact_url": { "type": "string", "description": "URL of the preferred contact page", "nullable": true }, "contributor_url": { "type": "string", "description": "URL of the user\u2019s or entity\u2019s Local Guides profile, if available", "nullable": true }, "book_online_url": { "type": "string", "description": "URL in the \u2018book online\u2019 button of the element\nURL directing users to the online booking or order page of the business entity", "nullable": true }, "domain": { "type": "string", "description": "domain of the business entity", "nullable": true }, "logo": { "type": "string", "description": "URL of the logo featured in Google My Business profile", "nullable": true }, "main_image": { "type": "string", "description": "URL of the main image featured in Google My Business profile", "nullable": true }, "total_photos": { "type": "integer", "description": "total count of images featured in Google My Business profile", "format": "int64", "nullable": true }, "snippet": { "type": "string", "description": "additional information on the business entity", "nullable": true }, "latitude": { "type": "number", "description": "latitude coordinate of the local establishments in google maps\nexample:\n\"latitude\": 51.584091", "nullable": true }, "longitude": { "type": "number", "description": "longitude coordinate of the local establishment in google maps\nexample:\n\"longitude\": -0.31365919999999997", "nullable": true }, "is_claimed": { "type": "boolean", "description": "shows whether the entity is verified by its owner on Google Maps", "nullable": true }, "attributes": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataAttributesInfo" } ], "description": "service details in a form of user-reviewed checks;\nservice details of a business entity displayed in a form of checks and based on user feedback and business category", "nullable": true }, "place_topics": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "nullable": true }, "description": "keywords mentioned in customer reviews\ncontains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword\nexample: \n\"place_topics\": {\n\"egg roll\": 48,\n\"birthday\": 33\n}", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the element\u2019s rating \nthe popularity rate based on reviews and displayed in SERP", "nullable": true }, "hotel_rating": { "type": "string", "description": "hotel class rating\nclass ratings range between 1-5 stars, learn more\nif there is no hotel class rating information, the value will be null", "nullable": true }, "price_level": { "type": "string", "description": "property price level\ncan take values: inexpensive, moderate, expensive, very_expensive\nif there is no price level information, the value will be null", "nullable": true }, "rating_distribution": { "type": "object", "additionalProperties": { "type": "integer", "format": "Int64", "nullable": true }, "description": "the distribution of ratings of the business entity\nthe object displays the number of 1-star to 5-star ratings, as reviewed by users", "nullable": true }, "people_also_search": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PeopleAlsoSearch" } ], "nullable": true }, "description": "related business entities", "nullable": true }, "work_time": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessWorkHoursInfo" } ], "description": "work time details\ninformation related to operational hours of the business entity", "nullable": true }, "popular_times": { "type": "object", "description": "popular times\ninformation related to busy hours of the business entity", "nullable": true }, "local_business_links": { "type": "object", "description": "available interactions with the business\nlist of options to interact with the business directly from search results", "nullable": true }, "is_directory_item": { "type": "boolean", "description": "business establishment is a part of the directory\nindicates whether the business establishment is a part of the directory;\nif true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre);\nnote: if the business establishment is a parent item in the directory, the value will be null", "nullable": true }, "directory": { "type": "object", "description": "items of the directory\nincludes information about businesses that are located within the target business establishment and have the same address", "nullable": true } } }, "BusinessDataGoogleHotelInfoTaskPostRequestInfo": { "type": "object", "properties": { "hotel_identifier": { "type": "string", "description": "unique hotel identifier\nrequired field if you don\u2019t specify keyword\nif you use this field, you don\u2019t need to specify keyword\nunique identifier of a hotel entity in Google search;\nyou can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels_pack element of the response), or the Hotel Searches endpoint of Business Data API\nexample:\nChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE", "nullable": true }, "keyword": { "type": "string", "description": "keyword\nrequired field if you don\u2019t specify hotel_identifier\nif you use this field, you don\u2019t need to specify hotel_identifier\nthe keyword you specify should indicate the name of the hotel entity\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character)\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "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 with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/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\u00a0or 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 with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations\nexample:\n2840", "nullable": true }, "location_coordinate": { "type": "string", "description": "GPS coordinates of a location\nrequired field if you don\u2019t specify location_name\u00a0or 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 maximum number of decimal digits for \u201clatitude\u201d and \u201clongitude\u201d: 7\nNote: if the coordinates are used to set a location, the search will occur in the nearest settlement;\nexample:\n53.476225,-2.243572", "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 with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nEnglish", "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 with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages\nexample:\nen", "nullable": true }, "check_in": { "type": "string", "description": "check-in date\noptional field\nif you don\u2019t specify this field, tomorrow\u2019s date will be used by default;\nthe value must not be earlier than today\u2019s date\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "check_out": { "type": "string", "description": "check-out date\noptional field\nif you don\u2019t specify this field, our system will apply the date of two days from now by default;\nNote: the value cannot be less than or equal to check_in;\nthe range between check_in and check_out values cannot exceed 30 days\ndate format: \"yyyy-mm-dd\"\nexample:\n\"2019-01-15\"", "nullable": true }, "currency": { "type": "string", "description": "currency\noptional field\nexample:\n\"USD\"", "nullable": true }, "adults": { "type": "integer", "description": "number of adults\noptional field\nif you don\u2019t specify this field, two adults will be used by default\nexample:\n1", "nullable": true }, "children": { "type": "array", "items": { "type": "string" }, "description": "number and age of children\noptional field\nif you don\u2019t specify this field, no children will be included in the search;\nset the following value if you want to include one 14-years-old child:\n[14]\nset the following value if you want to include one 13-years-old child and one 8-years-old child:\n[13,8]", "nullable": true }, "load_prices_by_dates": { "type": "boolean", "description": "load hotel stay prices by dates\noptional field\nif you specify this parameter with true, the response will include the prices_by_dates array with hotel stay prices divided by dates\nif you use this parameter, you will be charged double the base price for a request", "nullable": true }, "prices_start_date": { "type": "string", "description": "start date to load prices by dates\noptional field\nto use this parameter, you must specify load_prices_by_dates with true\nif this parameter is not specified, the start date is set to check_in date\ndate format: yyyy-mm-dd\nexample:\n2025-05-20", "nullable": true }, "prices_end_date": { "type": "string", "description": "end date to load prices by dates\noptional field\nto use this parameter, you must specify load_prices_by_dates with true\nif this parameter is not specified, you will get prices by date for the month\ndate format: yyyy-mm-dd\nexample:\n2025-05-21", "nullable": true }, "prices_date_range": { "type": "string", "description": "predefined period for retrieving daily price data\noptional field\nto use this parameter, you must specify load_prices_by_dates with true\nif the prices_start_date is not specified, the start date is set to check_in date\npossible values: month, three_months, six_months, year\ndefault value: month", "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 }, "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 }, "postback_data": { "type": "string", "description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible values:\nadvanced, html", "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;\nwe 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 } }, "example": [ { "language_code": "en", "location_name": "New York,New York,United States", "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE", "tag": "some_string_123", "postback_url": "https://your-server.com/postbackscript.php", "postback_data": "advanced" } ] }, "BusinessDataGoogleHotelInfoTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleHotelInfoTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleHotelInfoTaskPostTaskInfo": { "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 } } } ] }, "BusinessDataGoogleMyBusinessUpdatesTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessUpdatesTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "BusinessDataGoogleMyBusinessUpdatesTasksReadyResultInfo": { "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\ncan take the following values: google", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "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 } } } } }