keyword filedkeyword, please specify it as “%25”; this field can also be used to pass the following parameters:cid - a unique, google-defined id of the business entity;place_id - an identifier of the business entity in Google Maps;
example:cid:194604053573767737place_id:GhIJQWDl0CIeQUARxks3icF8U8A
learn more about the cid and place_id identifiers in this help center article
learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
},
"location_name": {
"type": "string",
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you 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
example:London,England,United Kingdom"
},
"location_code": {
"type": "integer",
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you 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
example:2840n"
},
"location_coordinate": {
"type": "string",
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude,radius\" format
the maximum number of decimal digits for \"latitude\" and \"longitude\": 7
the minimum value for \"radius\": 199.9 (mm)
the maximum value for \"radius\": 199999 (mm)
example:53.476225,-2.243572,200n"
},
"language_name": {
"type": "string",
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you 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
example:English"
},
"language_code": {
"type": "string",
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:enn"
},
"tag": {
"type": [
"string",
"null"
],
"description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response"
}
},
"example": [
{
"language_code": "en",
"location_name": "New York,New York,United States",
"keyword": "RustyBrick, Inc."
}
]
}
]
},
"example": [
{
"language_code": "en",
"location_name": "New York,New York,United States",
"keyword": "RustyBrick, Inc."
}
]
}
```
## Responses
### 200 — Successful operation
Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataGoogleMyBusinessInfoLiveResponseInfo"
}
]
}
```
### 400 — The request could not be processed. Check the request parameters.
### 401 — A valid Felo API key is required.
### 402 — The request cannot proceed because a billing requirement is not met.
### 403 — The account is not permitted to perform this operation.
### 429 — A request or spending limit has been reached.
### 502 — The service could not complete the request.
### 503 — The API or billing service is temporarily unavailable.
### 504 — The service timed out while processing the request.
### default — Error response; upstream passthrough responses may use provider formats
**application/json**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_AddressInfo
`#/components/schemas/Response36Afe1097B20_AddressInfo`
```json
{
"type": "object",
"properties": {
"borough": {
"type": [
"string",
"null"
],
"description": "administrative unit or district the local establishment belongs to"
},
"address": {
"type": [
"string",
"null"
],
"description": "street address of the local establishment"
},
"city": {
"type": [
"string",
"null"
],
"description": "name of the city where the local establishment is located"
},
"zip": {
"type": [
"string",
"null"
],
"description": "ZIP code of the local establishment"
},
"region": {
"type": [
"string",
"null"
],
"description": "DMA region the local establishment belongs to"
},
"country_code": {
"type": [
"string",
"null"
],
"description": "ISO country code of the local establishment"
}
}
}
```
### Response36Afe1097B20_BaseLocalBusinessLink
`#/components/schemas/Response36Afe1097B20_BaseLocalBusinessLink`
```json
{
"type": "object",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "type of element"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "type",
"mapping": {
"reservation": "#/components/schemas/Response36Afe1097B20_LocalBusinessReservationLink",
"order": "#/components/schemas/Response36Afe1097B20_LocalBusinessOrderLink",
"menu": "#/components/schemas/Response36Afe1097B20_LocalBusinessMenuLink"
}
}
}
```
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "the current version of the API"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "general status code\nyou can find the full list of the response codes here"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "general informational message\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "total execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array returned with an error",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "task identifier\nunique task identifier in our system in the UUID format"
},
"status_code": {
"type": [
"integer",
"null"
],
"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"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "informational message of the task\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "number of elements in the result array",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "URL path"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "contains the same parameters that you specified in the POST request"
}
}
}
```
### Response36Afe1097B20_BusinessDataAttributesInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataAttributesInfo`
```json
{
"type": "object",
"properties": {
"available_attributes": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
}
},
"description": "available attributes
indicates attributes a business entity can offer"
},
"unavailable_attributes": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
}
},
"description": "unavailable attributes
indicates attributes a business entity cannot offer"
}
}
}
```
### Response36Afe1097B20_BusinessDataGoogleMyBusinessInfoLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataGoogleMyBusinessInfoLiveResponseInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataGoogleMyBusinessInfoLiveTaskInfo"
}
]
},
"description": "array of tasks"
}
}
}
]
}
```
### Response36Afe1097B20_BusinessDataGoogleMyBusinessInfoLiveResultInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataGoogleMyBusinessInfoLiveResultInfo`
```json
{
"type": "object",
"properties": {
"keyword": {
"type": [
"string",
"null"
],
"description": "keyword received in a POST array
keyword is returned with decoded %## (plus character '+' will be decoded to a space character)
this field will contain the cid parameter if you specified it in the keyword field when setting a task;
example:cid:2946633002421908862
learn more about the parameter in this help center article"
},
"se_domain": {
"type": [
"string",
"null"
],
"description": "search engine domain as specified in a POST array"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "location code in a POST array"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "language code in a POST array"
},
"check_url": {
"type": [
"string",
"null"
],
"description": "direct URL to search engine results
you can use it to make sure that we provided accurate results"
},
"datetime": {
"type": [
"string",
"null"
],
"description": "date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:2019-11-15 12:57:46 +00:00"
},
"item_types": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "item types
types of search engine results encountered in the items array;
possible item types: google_business_info"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "item types
the number of items in the items array",
"format": "int64"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_GoogleBusinessInfo"
}
]
},
"description": "encountered item types
types of search engine results encountered in the items array;
possible item types: google_business_info"
}
}
}
```
### Response36Afe1097B20_BusinessDataGoogleMyBusinessInfoLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataGoogleMyBusinessInfoLiveTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataGoogleMyBusinessInfoLiveResultInfo"
}
]
},
"description": "array of results"
}
}
}
]
}
```
### Response36Afe1097B20_BusinessDataServiceInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataServiceInfo`
```json
{
"type": "object",
"properties": {
"category": {
"type": [
"string",
"null"
],
"description": "business category
Google My Business general category that best describes the services provided by the business entity"
},
"title": {
"type": [
"string",
"null"
],
"description": "title of the element in SERP
the name of the business entity for which the results are collected"
},
"snippet": {
"type": [
"string",
"null"
],
"description": "additional information on the business entity"
},
"price": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PriceInfo"
}
]
}
}
}
```
### Response36Afe1097B20_BusinessDirectoryInfo
`#/components/schemas/Response36Afe1097B20_BusinessDirectoryInfo`
```json
{
"type": "object",
"properties": {
"title": {
"type": [
"string",
"null"
],
"description": "title of the element
domain of the online menu system"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_MapsSearch"
}
]
},
"description": "encountered item types
types of search engine results encountered in the items array;
possible item types: google_business_info"
}
}
}
```
### Response36Afe1097B20_BusinessWorkHoursInfo
`#/components/schemas/Response36Afe1097B20_BusinessWorkHoursInfo`
```json
{
"type": "object",
"properties": {
"work_hours": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_WorkHours"
}
],
"description": "open hours
information about work hours of the local establishment"
}
}
}
```
### Response36Afe1097B20_GoogleBusinessInfo
`#/components/schemas/Response36Afe1097B20_GoogleBusinessInfo`
```json
{
"type": "object",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "type of element"
},
"rank_group": {
"type": [
"integer",
"null"
],
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group"
},
"rank_absolute": {
"type": [
"integer",
"null"
],
"description": "absolute rank among all the elements"
},
"position": {
"type": [
"string",
"null"
],
"description": "the alignment in SERP"
},
"title": {
"type": [
"string",
"null"
],
"description": "title of the element in SERP
the name of the business entity for which the results are collected"
},
"original_title": {
"type": [
"string",
"null"
],
"description": "original title of the element
original title not translated by Google"
},
"description": {
"type": [
"string",
"null"
],
"description": "description of the element in SERP
the description of the business entity for which the results are collected"
},
"category": {
"type": [
"string",
"null"
],
"description": "business category
Google My Business general category that best describes the services provided by the business entity"
},
"category_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "global category IDs
universal category IDs that do not change based on the selected country"
},
"additional_categories": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "additional business categories
additional Google My Business categories that describe the services provided by the business entity in more detail"
},
"cid": {
"type": [
"string",
"null"
],
"description": "google-defined client id
unique id of a local establishment;
can be used with Google Reviews API to get a full list of reviews
learn more about the identifier in this help center article"
},
"feature_id": {
"type": [
"string",
"null"
],
"description": "the unique identifier of the element in SERP
learn more about the identifier in this help center article"
},
"address": {
"type": [
"string",
"null"
],
"description": "address of the business entity"
},
"address_info": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_AddressInfo"
}
],
"description": "object containing address components of the business entity"
},
"place_id": {
"type": [
"string",
"null"
],
"description": "unique place identifier
place id of the local establishment featured in the element
learn more about the identifier in this help center article"
},
"phone": {
"type": [
"string",
"null"
],
"description": "phone number of the business entity"
},
"url": {
"type": [
"string",
"null"
],
"description": "absolute url of the business entity"
},
"contact_url": {
"type": [
"string",
"null"
],
"description": "URL of the preferred contact page"
},
"contributor_url": {
"type": [
"string",
"null"
],
"description": "URL of the user's or entity's Local Guides profile, if available"
},
"book_online_url": {
"type": [
"string",
"null"
],
"description": "URL in the 'book online' button of the element
URL directing users to the online booking or order page of the business entity"
},
"domain": {
"type": [
"string",
"null"
],
"description": "domain of the business entity"
},
"logo": {
"type": [
"string",
"null"
],
"description": "URL of the logo featured in Google My Business profile"
},
"main_image": {
"type": [
"string",
"null"
],
"description": "URL of the main image featured in Google My Business profile"
},
"total_photos": {
"type": [
"integer",
"null"
],
"description": "total count of images featured in Google My Business profile",
"format": "int64"
},
"snippet": {
"type": [
"string",
"null"
],
"description": "additional information on the business entity"
},
"latitude": {
"type": [
"number",
"null"
],
"description": "latitude coordinate of the local establishments in google maps
example:\"latitude\": 51.584091"
},
"longitude": {
"type": [
"number",
"null"
],
"description": "longitude coordinate of the local establishment in google maps
example:\"longitude\": -0.31365919999999997"
},
"is_claimed": {
"type": [
"boolean",
"null"
],
"description": "shows whether the entity is verified by its owner on Google Maps"
},
"questions_and_answers_count": {
"type": [
"integer",
"null"
]
},
"attributes": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataAttributesInfo"
}
],
"description": "service details in a form of user-reviewed checks;
service details of a business entity displayed in a form of checks and based on user feedback and business category"
},
"place_topics": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"description": "keywords mentioned in customer reviews
contains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword
example:
\"place_topics\": {
\"egg roll\": 48,
\"birthday\": 33
}
the popularity rate based on reviews and displayed in SERP"
},
"hotel_rating": {
"type": [
"number",
"null"
],
"description": "hotel class rating
class ratings range between 1-5 stars, learn more
if there is no hotel class rating information, the value will be null"
},
"price_level": {
"type": [
"string",
"null"
],
"description": "property price level
can take values: inexpensive, moderate, expensive, very_expensive
if there is no price level information, the value will be null"
},
"rating_distribution": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"integer",
"null"
],
"format": "Int64"
},
"description": "the distribution of ratings of the business entity
the object displays the number of 1-star to 5-star ratings, as reviewed by users"
},
"people_also_search": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PeopleAlsoSearch"
}
]
},
"description": "related business entities"
},
"work_time": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessWorkHoursInfo"
}
],
"description": "work time details
information related to operational hours of the business entity"
},
"popular_times": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PopularTimes"
}
],
"description": "popular times
information related to busy hours of the business entity"
},
"local_business_links": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseLocalBusinessLink"
}
]
},
"description": "available interactions with the business
list of options to interact with the business directly from search results"
},
"is_directory_item": {
"type": [
"boolean",
"null"
],
"description": "business establishment is a part of the directory
indicates whether the business establishment is a part of the directory;
if true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre);
note: if the business establishment is a parent item in the directory, the value will be null"
},
"directory": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDirectoryInfo"
}
],
"description": "items of the directory
includes information about businesses that are located within the target business establishment and have the same address"
},
"services": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataServiceInfo"
}
]
},
"description": "list of services offered by the business"
}
}
}
```
### Response36Afe1097B20_MapsSearch
`#/components/schemas/Response36Afe1097B20_MapsSearch`
```json
{
"type": "object",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "type of element"
},
"rank_group": {
"type": [
"integer",
"null"
],
"description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from the rank_group"
},
"rank_absolute": {
"type": [
"integer",
"null"
],
"description": "absolute rank among all the elements"
},
"domain": {
"type": [
"string",
"null"
],
"description": "domain of the business entity"
},
"title": {
"type": [
"string",
"null"
],
"description": "directory title
can take the following values: At this place, Directory"
},
"url": {
"type": [
"string",
"null"
],
"description": "URL to view the menu"
},
"rating": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_RatingInfo"
}
],
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP"
},
"rating_distribution": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"integer",
"null"
],
"format": "Int64"
},
"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"
},
"snippet": {
"type": [
"string",
"null"
],
"description": "additional information about the business entity"
},
"address": {
"type": [
"string",
"null"
],
"description": "address of the business entity"
},
"address_info": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_AddressInfo"
}
],
"description": "object containing address components of the business entity"
},
"place_id": {
"type": [
"string",
"null"
],
"description": "unique place identifier
place id of the local establishment featured in the element
learn more about the identifier in this help center article"
},
"phone": {
"type": [
"string",
"null"
],
"description": "phone number of the business entity"
},
"main_image": {
"type": [
"string",
"null"
],
"description": "URL of the main image featured in Google My Business profile"
},
"total_photos": {
"type": [
"string",
"null"
],
"description": "total count of images featured in Google My Business profile",
"format": "int64"
},
"category": {
"type": [
"string",
"null"
],
"description": "business category
Google My Business general category that best describes the services provided by the business entity"
},
"additional_categories": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "additional business categories
additional Google My Business categories that describe the services provided by the business entity in more detail"
},
"price_level": {
"type": [
"string",
"null"
],
"description": "property price level
can take values: inexpensive, moderate, expensive, very_expensive
if there is no price level information, the value will be null"
},
"hotel_rating": {
"type": [
"string",
"null"
],
"description": "hotel class rating
class ratings range between 1-5 stars, learn more
if there is no hotel class rating information, the value will be null"
},
"category_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "global category IDs
universal category IDs that do not change based on the selected country"
},
"work_hours": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessWorkHoursInfo"
}
],
"description": "open hours
information about work hours of the local establishment"
},
"feature_id": {
"type": [
"string",
"null"
],
"description": "the unique identifier of the element in SERP
learn more about the identifier in this help center article"
},
"cid": {
"type": [
"string",
"null"
],
"description": "google-defined client id
unique id of a local establishment;
can be used with Google Reviews API to get a full list of reviews
learn more about the identifier in this help center article"
},
"latitude": {
"type": [
"number",
"null"
],
"description": "latitude coordinate of the local establishments in google maps
example:\"latitude\": 51.584091"
},
"longitude": {
"type": [
"number",
"null"
],
"description": "longitude coordinate of the local establishment in google maps
example:\"longitude\": -0.31365919999999997"
},
"is_claimed": {
"type": [
"boolean",
"null"
],
"description": "shows whether the entity is verified by its owner on Google Maps"
},
"local_justifications": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Google local justifications
snippets of text that “justify” why the business is showing up for search query"
},
"is_directory_item": {
"type": [
"boolean",
"null"
],
"description": "business establishment is a part of the directory
indicates whether the business establishment is a part of the directory;
if true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre);
note: if the business establishment is a parent item in the directory, the value will be null"
}
}
}
```
### Response36Afe1097B20_PeopleAlsoSearch
`#/components/schemas/Response36Afe1097B20_PeopleAlsoSearch`
```json
{
"type": "object",
"properties": {
"cid": {
"type": [
"string",
"null"
],
"description": "google-defined client id
unique id of a local establishment
learn more about the identifier in this help center article"
},
"feature_id": {
"type": [
"string",
"null"
],
"description": "the unique identifier of the element in SERP
learn more about the identifier in this help center article"
},
"title": {
"type": [
"string",
"null"
],
"description": "title of the element in SERP
the name of the business entity for which the results are collected"
},
"rating": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_RatingInfo"
}
],
"description": "the element's rating
the popularity rate based on reviews and displayed in SERP"
}
}
}
```
### Response36Afe1097B20_PopularTimes
`#/components/schemas/Response36Afe1097B20_PopularTimes`
```json
{
"type": "object",
"properties": {
"popular_times_by_days": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PopularWorkTimeInfo"
}
],
"description": "work hours on Sundays"
}
},
"description": "popular hours
information about busy hours of the local establishment on each day of the week"
}
}
}
```
### Response36Afe1097B20_PopularWorkTimeInfo
`#/components/schemas/Response36Afe1097B20_PopularWorkTimeInfo`
```json
{
"type": "object",
"properties": {
"time": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TimeInfo"
}
],
"description": "hours in the 24-hour format"
},
"popular_index": {
"type": [
"integer",
"null"
],
"description": "popularity index\nrelative time-bound popularity index measured from 0 to 100;\nhigher value corresponds to a busier time of a day"
}
}
}
```
### Response36Afe1097B20_PriceInfo
`#/components/schemas/Response36Afe1097B20_PriceInfo`
```json
{
"type": "object",
"properties": {
"current": {
"type": [
"number",
"null"
],
"description": "current price\nindicates the current price of the product or service featured in the result",
"format": "double"
},
"regular": {
"type": [
"number",
"null"
],
"description": "regular price\nindicates the regular price of the product or service with no discounts applied",
"format": "double"
},
"max_value": {
"type": [
"number",
"null"
],
"description": "the maximum price\nthe maximum price of the product or service as indicated in the result",
"format": "double"
},
"currency": {
"type": [
"string",
"null"
],
"description": "currency of the listed price\nISO code of the currency applied to the price"
},
"is_price_range": {
"type": [
"boolean",
"null"
],
"description": "price is provided as a range\nindicates whether a price is provided in a range"
},
"displayed_price": {
"type": [
"string",
"null"
],
"description": "price string in the result\nraw price string as provided in the result"
}
}
}
```
### Response36Afe1097B20_RatingInfo
`#/components/schemas/Response36Afe1097B20_RatingInfo`
```json
{
"properties": {
"rating_type": {
"type": [
"string",
"null"
],
"description": "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax"
},
"value": {
"type": [
"number",
"null"
],
"description": "the value of the rating",
"format": "double"
},
"votes_count": {
"type": [
"integer",
"null"
],
"description": "the amount of feedback",
"format": "int64"
},
"rating_max": {
"type": [
"integer",
"null"
],
"description": "the maximum value for a rating_type"
}
}
}
```
### Response36Afe1097B20_TimeInfo
`#/components/schemas/Response36Afe1097B20_TimeInfo`
```json
{
"type": "object",
"properties": {
"hour": {
"type": [
"integer",
"null"
],
"description": "hours in the 24-hour format"
},
"minute": {
"type": [
"integer",
"null"
],
"description": "minutes"
}
}
}
```
### Response36Afe1097B20_WorkDayInfo
`#/components/schemas/Response36Afe1097B20_WorkDayInfo`
```json
{
"type": "object",
"properties": {
"open": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TimeInfo"
}
],
"description": "opening time"
},
"close": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TimeInfo"
}
],
"description": "closing time"
}
}
}
```
### Response36Afe1097B20_WorkHours
`#/components/schemas/Response36Afe1097B20_WorkHours`
```json
{
"type": "object",
"properties": {
"timetable": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_WorkDayInfo"
}
],
"description": "work hours on Sundays"
}
},
"description": "work hours timetable"
},
"current_status": {
"type": [
"string",
"null"
],
"description": "current status of the establishment
indicates whether the establishment is opened or closed"
}
}
}
```