Your agent needs what customers say in public — Google Business profiles and reviews, Trustpilot, Tripadvisor, hotel listings and the Q&A under a listing.
What you can ask for • "Pull this business's Google reviews and group the complaints." • "What do Trustpilot reviewers say about this competitor?" • "Find hotels matching this search and their live prices." • "What questions are people asking on this Google listing, and are they answered?" • "Search listings for this category in this city."
How to use it Point any MCP client at https://mcp.aisa.one/seo-business/mcp and sign in with OAuth — there is no key to create or paste. 22 tools: Google Business info, reviews, extended reviews, updates and Q&A; Trustpilot and Tripadvisor search and reviews; Google hotel info and searches; business listing search; plus Reddit and Pinterest signals for a business.
It is also a door to the rest The same login reaches 26 sources and 580+ operations. Read the reviews here, then ask the same agent what that business ranks for or who links to it — without adding a second server.
What it costs Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident.
Where else it reaches https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Scored across 29 tools
Nearly every DataForSEO endpoint appears twice in two flavors (get_*_fetch vs post_*_submit) for Google reviews, GMB updates, Tripadvisor and Trustpilot, and the descriptions do not make it clear when an agent should retrieve versus submit. On top of that, the meta-tools (search, batch_quote, batch_use) overlap with the direct endpoint tools, and `use` exists only as a deprecated sibling of `batch_use`, so a tool can be misselected.
All names are snake_case and the long DataForSEO names follow a systematic prefix_vendor_product_method pattern, which is readable. But the surface mixes bare nouns (`account`), bare verbs (`search`, `use`), `batch_*` meta-tools, and 50-character vendor names, so there is no single predictable convention.
At 29 tools the set exceeds the comfortable range, and several are dead weight or duplicates (the deprecated `use`, plus the fetch/submit pairs for each platform). The core domain needs only about half of these to cover the same ground.
Coverage of the stated domain is strong: business info, updates, QA, hotel info and searches, listing search, and search plus reviews for Google, Tripadvisor and Trustpilot. Minor gaps remain (no Yelp or Facebook sources, no task-management or cancel operations for submitted DataForSEO tasks, and oddly placed Pinterest/Reddit share-count tools).
Who am I, what can I use, how much can I spend: the key, the account balance, the Go-to-Market wallet when one is active, and usage for today, 7 days and 30 days. Free; needs the Authorization header. Call it to verify a new connection or to explain a 402. ok is true only when the balance was read; otherwise each entry of errors says what to do in next_step.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds substantial context beyond the readOnlyHint/openWorldHint/destructiveHint annotations: the call is free, it requires the Authorization header, and it discloses result semantics ('ok is true only when the balance was read; otherwise each entry of errors says what to do in next_step'). That tells an agent how to interpret partial failure, which annotations cannot convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with what the agent gets, followed by cost/auth, then call triggers, then result interpretation. No sentence is redundant and none could be dropped without losing information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter read tool with an output schema already present, the description covers the remaining gaps: cost, auth requirement, invocation triggers, and the ok/errors/next_step contract. Nothing an agent needs to call or interpret it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so the description has nothing parameter-level to compensate for, and the schema is fully covered. A 4 rather than 5 reflects that it adds no input-syntax detail, though none is possible here.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a concrete resource set (identity/key, account balance, Go-to-Market wallet, usage over 1/7/30 days) rather than restating the name. It is clearly distinguishable from every sibling, which are all Reddit, batch, or search tools. An agent knows exactly what it will learn by calling it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit triggering conditions are given: 'Call it to verify a new connection or to explain a 402.' That is a strong when-to-use statement. It stops short of 5 because it names no alternative tool or a when-not condition, though the sibling list offers no obvious competing diagnostic.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Retrieve schemas for 1 to 20 exact tool names from search. Build arguments from successful schemas, then call batch_quote. Do not call batch_use yet. Use tool names exactly as search returns them, without a client prefix such as mcp__aisa__. Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.
| Name | Required | Description | Default |
|---|---|---|---|
| tools | Yes | Exact tool names returned by search whose complete contracts are needed. Never invent tool names. | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. | |
| include_documentation | No | Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support. | |
| include_response_schema | No | Return the complete response_schema. Defaults to false. | |
| include_arguments_schema | No | Return the complete arguments_schema. Defaults to true. |
| Name | Required | Description |
|---|---|---|
| tools | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| error_count | Yes | |
| total_count | Yes | |
| success_count | Yes | |
| next_steps_guidance | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description is not required to restate it. It adds genuine operational context: the batch_use prohibition, exact-name/prefix requirements, and session reuse semantics. It does not cover failure handling when names are invalid, keeping it below a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action and size limit, and every sentence carries workflow value. The session_id sentence duplicates the schema's own parameter description, which is minor redundancy rather than bloat.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only batch retrieval tool with an output schema, the description supplies the orchestration context an agent needs (source of names, next steps, session handling) without needing to explain return values. Nothing essential to correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds real meaning beyond the schema by constraining names to those returned by search and warning against a client prefix such as mcp__aisa__, which is not encoded in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Retrieve schemas for 1 to 20 exact tool names') and pins the source of those names to search. This clearly separates it from siblings like search (finds tools), batch_quote, and batch_use.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly sequences the workflow: build arguments from successful schemas, then call batch_quote, and 'Do not call batch_use yet.' This is an explicit when-to-use and when-not-to-use instruction naming the alternative siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Obtain AIsaServices cost quotes for 1 to 20 published tools without executing them. Same input as batch_use: exact tool names and schema-valid arguments. Never falls back to execution. The response reports auto_execute_eligible and auto_execute_threshold_micros_usd. auto_execute_eligible waives only the extra cost-confirmation step and does not override a user prohibition on execution, a narrower scope, or a tighter budget limit. Quotes are price observations, not authorization grants. Use tool names exactly as search returns them, without a client prefix such as mcp__aisa__. Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.
| Name | Required | Description | Default |
|---|---|---|---|
| calls | Yes | ||
| search_id | No | Optional search correlation identifier returned by search. | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| Name | Required | Description |
|---|---|---|
| results | Yes | |
| batch_id | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| error_count | Yes | |
| total_count | Yes | |
| success_count | Yes | |
| next_steps_guidance | Yes | Deterministic next-step instructions derived from this result. Not an authorization grant. |
| auto_execute_eligible | No | True when the worst-known total of successful USD quotes is at or below auto_execute_threshold_micros_usd. A non-USD successful quote makes the batch ineligible. Present on quote responses. |
| auto_execute_threshold_micros_usd | No | Configured auto-execute threshold in micro-USD. 0 disables automatic execution. Present on quote responses. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well past the readOnly/idempotent annotations by explaining that quotes are price observations rather than authorization grants, and precisely delimiting what auto_execute_eligible does and does not waive (user prohibition, narrower scope, tighter budget). It also guarantees no execution fallback, which is the key behavioral risk for this tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded and most sentences carry distinct rules (no fallback, eligibility limits, naming, session reuse). It is on the long side and the argument-shape constraint is stated twice in spirit, but little is truly wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value documentation isn't required, yet the description still flags the two response fields that matter for a downstream decision. Combined with session and naming guidance, an agent has everything needed to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
At 67% schema coverage the schema already documents each parameter, so the description earns credit only for added meaning: exact-name rules for 'tool', session_id reuse semantics, and the 1-to-20 argument-shape parallel with batch_use. It doesn't clarify search_id beyond what the schema states.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Obtain AIsaServices cost quotes for 1 to 20 published tools') plus the crucial scope qualifier 'without executing them.' It is immediately distinguishable from the sibling batch_use, which executes rather than quotes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names the parallel sibling ('Same input as batch_use') and draws the boundary ('Never falls back to execution'). It also gives operational conditions: use names exactly as search returns them, strip any mcp__aisa__ prefix, and reuse session_id from Search for the task.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Billable API calls can incur substantial charges. Never call before a successful batch_quote for the same tools and arguments. Execute only when that quote response reports auto_execute_eligible=true for these calls, or when explicit user authorization covers that cost and risk. auto_execute_eligible waives only the extra cost-confirmation step; it does not override a user prohibition on execution, a narrower scope, or a tighter budget limit. Re-quote if tools, arguments, or scope change. Execute 1 to 20 independent published-tool calls; never silently retry. A missing or failed quote is not free. Use tool names exactly as search returns them, without a client prefix such as mcp__aisa__. Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.
| Name | Required | Description | Default |
|---|---|---|---|
| calls | Yes | ||
| search_id | No | Optional search correlation identifier returned by search. | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| Name | Required | Description |
|---|---|---|
| results | Yes | |
| batch_id | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| error_count | Yes | |
| total_count | Yes | |
| success_count | Yes | |
| next_steps_guidance | Yes | Deterministic next-step instructions derived from this result. Not an authorization grant. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover mutability, destructiveness, and open-world behavior. The description adds critical business logic: billable calls, quote dependency, the meaning of auto_execute_eligible (waives only cost confirmation, not user prohibitions), and no silent retry. It doesn't detail rate limits or return format, but with an output schema present, that's acceptable.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense and front-loads the cost warning, but it packs many separate instructions into one block, making it less scannable. Some sentences like 'A missing or failed quote is not free' add value, but the overall flow could be better structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the destructive, open-world annotations and the presence of an output schema, the description covers the essential preconditions and behavioral constraints. It could mention error handling or partial failure behavior, but the core guidance is sufficient for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 67%, and the description adds important semantics: tool names must be exact without client prefix, session_id reuse guidance, and 1-20 call limit. It doesn't explain search_id, but the schema description for search_id is already clear enough.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb and resource: 'Execute 1 to 20 independent published-tool calls', and the title matches. It distinguishes itself from batch_quote by requiring a quote first, but doesn't explicitly contrast with the singular 'use' sibling, though that's implied by 'batch'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use and when-not-to-use conditions: only after a successful batch_quote with auto_execute_eligible=true or explicit user authorization. It also states re-quote conditions and prohibits silent retries, leaving little ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive reads, so the safety profile is covered. The description adds genuinely useful context beyond them: results reflect emulated location/search-engine settings, personalization is ignored, and check_url lets you verify relevance. It says nothing about rate limits, error states, or what happens for expired tasks.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is front-loaded with output-fidelity caveats rather than the tool's action, and the Incognito-mode verification sentence is tangential padding. It is not bloated, but the opening sentence does not earn its position.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values needn't be explained, yet most of the description is spent on result characteristics anyway. The critical missing pieces — that this is the fetch half of a submit/fetch pair and that the id must come from a prior submit — are absent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is a single parameter with 100% schema coverage, and the schema already documents the UUID format and 30-day validity window. The description adds no meaning beyond the schema, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states the retrieval action (fetch task results by id); it opens with 'The returned results are specific to...' and describes output characteristics instead of what the tool does. The verb+resource is only recoverable from the name/title. No sibling differentiation from the other *_fetch tools is provided.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to call this versus post_dataforseo_business_google_extended_reviews_submit (which presumably creates the task) or the other review-source fetch tools. Nothing explains that a task id from a prior submit is required, nor any timing/preconditions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds one genuinely useful behavioral fact – the cost is $0 per successful request – but it is boilerplate pricing text that says nothing about the retrieval behavior, task lifetime, or failure modes.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but that brevity is the result of having no content rather than being concise. The two sentences are a pricing template with HTML comment markers that consume the entire description while conveying nothing about the tool's operation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values need not be described, but the description still omits the most basic facts: that this retrieves results for a previously submitted GMB updates task, that the task id comes from the submit sibling, and the 30-day expiry. For a tool in a large family of near-identically named fetch tools, this leaves the agent with nothing to disambiguate on.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and there is only one parameter, whose UUID format and 30-day usability window are fully documented in the schema. The description adds no parameter meaning at all, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description body contains only an auto-generated pricing banner ('Published reference price: $0 USD per successful request') and never states what the tool does. The only hint of purpose comes from the title, not the description text. For an agent comparing this against sibling fetch/submit tools, this is effectively missing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of the companion post_dataforseo_business_google_gmb_updates_submit tool that presumably creates the task, and no note about the 30-day retrieval window that matters for deciding whether to call this. Nothing routes the agent between this tool and its siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, openWorld, non-destructive), and the description adds genuine extra context: results emulate the specified location/search engine with high fidelity and ignore personalized factors. It also points to check_url for independent verification, which is useful behavioral detail. It omits retrieval timing/completeness state, so not a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The prose is padded and not front-loaded: it opens with result-provenance detail rather than what the tool does. The pricing boilerplate and Incognito-mode aside add length without helping invocation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values needn't be explained, and the description adequately characterizes result semantics. However, for a task-result fetch it omits the flow context (id origin, availability window beyond the schema note) that an agent needs to call it at the right time.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With a single parameter at 100% schema coverage, the schema fully documents the id. The description references 'establishment name, search engine, location and language parameters,' which are not this tool's inputs and risk confusing the agent about what it must supply (only id). Baseline 3 applies since the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The name and title indicate fetching Google reviews results by id, but the description never states the core action (retrieving results of a previously submitted task). Instead it leads with how the returned data was generated, leaving the verb+resource implicit. It also does not distinguish this fetch tool from siblings like get_dataforseo_business_google_extended_reviews_fetch or the submit counterpart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance is given: it never says the id must come from post_dataforseo_business_google_reviews_submit nor that results are only available after task completion. The only actionable instruction is to verify via check_url in Incognito mode, which is a verification tip rather than usage routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides feedback data on businesses listed on the Tripadvisor platform, including their locations, ratings, review content and count. The results are specific to the URL path indicated in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds useful content-level detail (the returned feedback includes locations, ratings, review text and count), but it omits operational traits such as the retrieval validity window and whether the same id can be polled repeatedly — the 30-day window is only visible in the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The two substantive sentences are front-loaded and free of padding, but they are followed by an injected pricing block ('Published reference price: $0 USD per successful request...') that carries no selection value and dilutes the definition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value explanation is not required. Still, for a task-result retrieval tool the description should at minimum signal the submit-then-fetch workflow and the id's lifetime; both are left to the schema and sibling names, leaving the agent to infer the calling sequence.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With a single parameter and 100% schema description coverage, the schema already fully documents 'id' including UUID format and the 30-day reuse window. The description contributes nothing beyond that, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a resource (Tripadvisor business review/feedback data) and lists what it contains (locations, ratings, review content and count), so the general purpose is legible. However, it never states the actual mechanic of this tool — that it retrieves the stored result of a previously submitted task by task id — and it does nothing to distinguish itself from the many sibling *_reviews_fetch / *_search_fetch tools for Google, Trustpilot and Tripadvisor.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance at all: no mention that a task must first be created via post_dataforseo_business_tripadvisor_reviews_submit, no statement of when to prefer this fetch over the Tripadvisor search fetch, and no exclusions. The only hint ('results are specific to the URL path indicated in the POST request') is indirect and does not tell the agent when this call is appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint will provide you with data on businesses listed on the Tripadvisor platform. The results obtained through this endpoint are specific to the location (see the List of Tripadvisor Locations) and keyword parameters used in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive, open-world, so safety is covered. The description adds nothing about the async task model, the 30-day retrieval expiry, or that only previously-submitted tasks can be queried — the key behavioral fact an agent needs. The pricing block is the only extra and is boilerplate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two core sentences plus an embedded pricing comment block. The pricing boilerplate occupies significant space without helping tool selection, and the description is not front-loaded with the crucial 'fetch results by task id' framing.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Output schema exists so return-shape explanation is not required, but the description omits the async submit-then-fetch workflow and the 30-day expiry, which are essential for correct invocation sequencing among the many sibling submit/fetch pairs. Context is incomplete despite a simple one-param schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the id field description already explains the UUID task identifier and the 30-day validity. The description contributes no additional semantics about the id or its relationship to the submit endpoint, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description says it provides 'data on businesses listed on the Tripadvisor platform' for a given location/keyword, which is a recognizable purpose, but it never states that this is a fetch-by-task-id retrieval step. The id param and the 'search_fetch' name imply it, yet the prose frames it as a search rather than a post-task result fetch.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance and no mention of the companion submit tool (post_dataforseo_business_tripadvisor_search_submit) or of the 30-day validity window that the schema hints at. The agent must infer that this retrieves results of a previously submitted task rather than running a new search.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides reviews published on the Trustpilot platform The returned results are specific to the indicated business entity. We emulate set parameters with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so safety is covered. The description adds meaningful behavior beyond that: results are task-bound, can be verified via check_url in Incognito, and personalized factors like search history are ignored. It doesn't mention task expiry or freshness windows, but the core behavioral profile is communicated.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is padded with marketing-style explanation about emulating parameters with highest accuracy and ignoring personalization. The first sentence states the purpose, but the remainder is verbose and tangential for a straightforward result-fetch endpoint. The pricing block is boilerplate rather than tool-specific guidance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given one fully documented parameter, annotations covering safety and idempotency, and an output schema present, the description is broadly sufficient. The main gap is the absence of explicit linkage to the corresponding submit endpoint and task expiry behavior, which would help an agent chain calls correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the schema fully documents the single 'id' parameter as a UUID task identifier with a 30-day retention window. The description adds no parameter-level detail beyond what the schema reliably provides, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific resource: reviews published on Trustpilot, specific to a business entity. This distinguishes it from sibling *_submit tools, which presumably create the task rather than fetch results. However, it doesn't explicitly name the paired *_submit alternative, so the differentiation is implicit rather than stated.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit statement of when to call this tool versus alternatives. The description implies result retrieval but never explains the submit-then-fetch flow or that the 'id' comes from a prior submit task. An agent must infer its usage from the surrounding tool set.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the keyword specified in a POST request. We emulate set parameters with the highest accuracy so that the results you receive match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus will not be reflected in the returned results.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds some genuine behavior context: results are emulated to match live search, personalized factors are ignored, and check_url can be used in Incognito to validate relevance. It omits other behavioral facts such as the 30-day retrieval window (which lives only in the schema) and pagination/result-size behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The body is padded with marketing prose about emulation accuracy and personalization that does not help an agent invoke the tool, plus a boilerplate pricing block. The front-loaded sentence points at the wrong operation (returning profiles rather than fetching a task's results), so the structure buries the one fact an agent needs.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained. However, for an async task-fetch endpoint the description should make the submit-then-fetch flow and the required task id explicit, and it does not; combined with no usage guidance, an agent cannot confidently sequence this tool against its submit sibling.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% with a single well-documented 'id' parameter, so the baseline is 3. The description adds nothing about the id beyond what the schema already says (UUID task identifier, usable for 30 days).
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the resource ('a list of business profiles listed on the Trustpilot platform') and implies a search-derived result set, but it reads like the *submit* endpoint's copy rather than a fetch-by-task-id operation. It never says the tool retrieves results of a previously created task using an id, so the specific verb+operation is muddled and the submit sibling is not referenced.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of the prerequisite submit step (post_dataforseo_business_trustpilot_search_submit) that produces the required id, and no routing versus the sibling fetch tools for other sources (Tripadvisor, Google reviews). The only hint of usage context is the check_url verification remark, which is incidental.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
The AIsa catalogue at a glance: categories, the servers in each, tool counts, and the dedicated endpoint to connect if you only need one category. Free. (AIsa-only: tool-router has no equivalent.) Use mcp.aisa.one/mcp?modules=<category> (or mcp.aisa.one/<category>/mcp) to have that category's tools listed directly instead of via search.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish that this is a safe, read-only, closed-world operation. The description adds useful context beyond annotations by saying it returns categories, servers, tool counts, and the dedicated endpoint, and that it is free. It omits auth/rate-limit details, but those are less critical given the read-only annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with what the tool returns and is generally efficient. The parenthetical about tool-router and the endpoint URL add some density, but each part contributes usage or content context.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With zero parameters, read-only annotations, and an output schema available, the description supplies enough context for correct invocation. It explains the catalogue contents and gives the category-specific endpoint alternative, leaving no critical gap for an agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so parameter semantics are not a meaningful differentiator. The schema has no properties to explain, and the description does not need to document any inputs.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that this tool gives a catalogue overview: categories, servers per category, tool counts, and a dedicated endpoint. The resource is specific and recognizable, though sibling differentiation is only partial because it references 'tool-router' rather than the listed siblings like search/use.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives a clear alternative: use the category-specific endpoint if you only need one category, rather than going via search. It also notes the tool is free and AIsa-only, but it does not explicitly state when to call list_categories instead of search or use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides results from the “Reviews” element of Google SERPs, including not only Google user reviews but also reviews from other reputable sources (e.g., TripAdvisor, Yelp, Trustpilot). The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare destructiveHint=true, readOnlyHint=false, idempotentHint=false, so this is a state-changing write, but the description's 'provides results' framing reads as passive retrieval. It omits the critical async behavior: this submits a task and results arrive via fetch, pingback, or postback. Only the pricing/cost boilerplate adds real behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded and compact: one sentence on data scope followed by a clearly demarcated pricing block. Little waste, though the opening sentence could carry more operational substance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return values need not be explained, but for an async task-submission tool with submit/fetch sibling pairs the description should disclose the submit-then-fetch workflow and retrieval options. That critical context is absent, leaving an agent unable to use the tool's results.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The top-level body parameter carries no description (0% coverage metric), though nested item properties are richly documented in the schema. The description only echoes that location and language parameters affect results, adding marginal meaning over the schema itself.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the resource (reviews in the 'Reviews' element of Google SERPs, aggregated from Google, TripAdvisor, Yelp, Trustpilot) but never says what the tool actually does. Named 'submit', it is a task-creation endpoint, yet the description frames it as one that 'provides results', leaving the core action vague.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It notes results depend on location and language parameters but gives no when-to-use guidance, no mention that a follow-up fetch (get_...extended_reviews_fetch) is needed to retrieve results, and no differentiation from the get_reviews_submit or tripadvisor_reviews_submit siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
Usage-based billing; Default request estimate: $0.0054 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already disclose the safety profile (readOnlyHint=false, destructiveHint=true, openWorldHint=true, idempotentHint=false). The description adds two useful non-annotation facts: results are location- and language-bound, and there is usage-based billing (~$0.0054/request, not fixed). It does not explain task-creation behavior vs. immediate return, or any auth/permission needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Sized reasonably at two content sentences plus a pricing block, but it is not front-loaded: it opens with invisible zero-width characters and then describes returned data rather than the action. The pricing comment is justified, but the leading framing sentence does little work.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained. However, for a task-submitting POST with an undocumented array-of-object body, the description omits the task nature, the keyword requirement, and any auth constraints, covering only location/language scoping.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema coverage is 0% – the sole 'body' array parameter carries no description, so the description must compensate. It only gestures at location and language settings and never mentions the required keyword field or that keyword also accepts cid/place_id identifiers, leaving the primary input semantics unexplained.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the resource domain ('information about specific business entity from Google') but frames it as what the API 'provides' rather than naming the action this tool performs (submitting/retrieving a live GMB info task). It gives no basis for choosing this tool over the many sibling GMB/QA/hotel tools beyond the narrow 'business entity' wording.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit when-to-use, when-not-to-use, or alternative-tool guidance. The only operative context is that results depend on location and language settings, which is a scoping note, not usage direction. An agent must infer from the name alone when this beats gmb_updates_fetch or qa_live.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoints provides the latest updates of a specific business entity from Google SERP. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description adds the useful pricing/billing estimate, but omits the key behavioral trait of a submit endpoint: it creates an asynchronous task that must later be fetched. That gap beyond annotations keeps it at 3.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short and front-loads the purpose statement, followed by location/language scoping and a clearly delimited pricing note. It is efficiently sized with little wasted prose, though the first sentence is slightly imprecise.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For an async task-submission endpoint with 0% top-level parameter coverage, the description should explain the submission/polling model and how the created task links to the fetch sibling. It instead reads like a synchronous data-retrieval description, leaving a significant behavioral gap; the output schema only spares it from explaining return values.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is reported as 0% (the 'body' parameter itself is undocumented). The description adds no parameter information and does not compensate for that gap, even though nested item properties happen to carry rich schema text. The description contributes nothing to parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description conveys the resource (latest updates of a business entity from Google SERP) but frames it as a retrieval ('provides the latest updates') rather than the task submission the name/title ('submit', 'Setting ... Tasks') imply. It does not distinguish itself from the sibling get_dataforseo_business_google_gmb_updates_fetch, leaving the submit-vs-fetch action ambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus the sibling fetch tool or alternatives. It only notes that results depend on location and language settings, without stating prerequisites (e.g. that a task is created and results must be retrieved via the fetch endpoint with the returned id).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, openWorldHint=true, idempotentHint=false, destructiveHint=true), which lowers the disclosure bar, and the description adds the payload contents plus a cost note (default estimate $0.2428 USD, variable pricing). However it says nothing about the POST/live semantics, the fact that it hits Google as an open-world call, or the charge-doubling behavior involved in pricing parameters. Note the mild tension: the description reads as a passive data fetch while annotations mark it destructive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core sentence is a single, front-loaded, information-dense statement of what the tool returns. The injected pricing block and leading whitespace add noise, but the description remains short and readable without redundant filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be re-explained, and the description does sketch the response contents. But for a data tool whose parameters are undocumented in the schema, it omits the reservation/location inputs and any usage context, leaving the definition only minimally complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The reported schema description coverage is 0% at the top level (the single 'body' parameter carries no description), so the description must compensate for parameter meaning and it does not. It never mentions hotel_identifier, the location_code/name/coordinate exclusivity, the language requirement, or the reservation fields, all of which drive correct invocation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb and resource: it retrieves structured data for a specific hotel entity on Google Hotels, and enumerates the returned fields (rating, amenities, reviews, prices). It clearly conveys the read/retrieval intent, but it never distinguishes itself from close siblings such as post_dataforseo_business_google_hotel_info_live_html or post_dataforseo_business_google_hotel_searches_live, leaving the agent to guess which endpoint applies.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit when-to-use guidance, no statement of prerequisites (e.g. that a hotel_identifier is needed and where it comes from), and no alternatives named. The only routing hint is scope ('a specific hotel entity'), which is implied rather than stated, so an agent must infer usage entirely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Google Hotel Info will provide you with unstructured HTML data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint=true, destructiveHint=true, idempotentHint=false, and the description usefully adds usage-based billing context ($0.2428 default estimate, not a fixed price, account-specific settlement). That billing note is genuine added value beyond the annotations, but the description never resolves why a data retrieval is flagged destructive, nor mentions task/latency or rate behavior. No direct contradiction, though the 'will provide you with data' framing is in mild tension with destructiveHint=true.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One sentence of substance plus a clearly demarcated pricing block; front-loaded with the resource and scope and free of filler. The pricing comment markers are noise an agent must skip, but the prose itself is tight.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value explanation is not needed. Still missing is the one thing that matters most here: the distinction between this live-HTML endpoint and its live-JSON sibling, plus acknowledgment that hotel_identifier is effectively mandatory despite the empty required array. Adequate but leaves a real selection gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema description coverage is 0% for the single top-level 'body' parameter, so the description should ideally carry some param burden, and it does not name a single request field. However, the nested schema itself documents every body property (hotel_identifier, check_in/check_out, adults, children, currency, language/location selectors) in detail, so an agent is not actually left blind. The description's field list describes returned content, not input semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb+resource: it returns unstructured HTML data for a specific hotel entity on the Google Hotels platform, and enumerates the content returned (description, location, rating, amenities, reviews, images, prices). It does not distinguish this '_html' variant from its sibling 'post_dataforseo_business_google_hotel_info_live', so an agent cannot tell the two apart without opening both schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no when-to-use guidance: it never says when to prefer the HTML variant over the structured JSON variant, nor that a hotel_identifier (and a location/language selector) must be supplied. There is no mention of alternatives or preconditions, so routing must come entirely from the schema and sibling names.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Hotel Searches API provides results containing information about different hotels listed on Google Hotels. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint, non-idempotent, and destructive traits, so the safety burden is largely carried. The description usefully adds the billing model ('usage-based billing; Default request estimate: $0.2428 USD') and the localization dependency, which the annotations do not. It does not, however, disclose that the call submits an array of async-style task objects or how billing multiplies with depth.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences followed by a clearly delimited pricing block; the core purpose is front-loaded with no wasted prose. The pricing comment markup is slightly noisy but is fenced and skimmable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need no explanation, and annotations cover safety. What is missing is the task-array calling convention, any pointer to the referenced Lists of Locations/Languages, and guidance on required location/language selection. Adequate but with clear holes for a live search tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema coverage for the top-level schema is 0%, and the description adds no parameter semantics at all. Critically, it never explains that the single 'body' parameter is an array of task objects, which is a structural fact an agent needs to build a valid call. Even though the nested field descriptions are rich, the description itself compensates for none of it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a clear resource and outcome: 'Hotel Searches API provides results containing information about different hotels listed on Google Hotels,' plus the location/language scoping. It reads as a retrieval/search capability, but never contrasts itself with near-neighbors like post_dataforseo_business_google_hotel_info_live, so the agent must infer the distinction.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no when-not-to, and no named alternative. The only contextual hint is that results depend on location and language settings, which is scope, not usage routing. With ~28 siblings including several hotel tools, this is a real gap.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds genuinely useful behavior beyond the annotations: billing is per 20 questions, a maximum of 5 answers is returned per question, and results are scoped to the chosen location and language. It does not reconcile the retrieval-style framing ('provide you with a detailed overview', 'access comprehensive data') with the destructiveHint=true / readOnlyHint=false annotations, nor does it mention auth, rate limits, or that this is a POST that spends balance on submission.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose and scope are front-loaded in the first paragraph, followed by billing constraints, with no wasted sentences. The leading invisible characters and the embedded pricing HTML comment are minor noise but do not impede reading.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and the description covers the cost model, answer cap, and location/language dependence. What remains missing is the task-submission/auth model and any note on why a retrieval endpoint carries destructive semantics.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is effectively 0% for the single 'body' wrapper, so the description must compensate and only partially does: it signals that location and language settings are needed and ties the 20-per-billing unit to depth, but never mentions the required keyword field or how cid/place_id can be passed. The nested per-property schema docs carry most of the load.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action and resource: retrieving questions and answers (full text plus timestamps and user metadata) for a business entity on Google My Business. That is enough to tell it apart from review-fetch or info-fetch siblings by resource, though it never names a sibling explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied — you would call this when you need GMB Q&A content for a business — and it points to the List of Locations and List of Languages for prerequisite values. There is no explicit when-not condition and no routing to alternatives such as the reviews or GMB info endpoints.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides results from the “Reviews” element of Google SERPs. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.
Usage-based billing; Default request estimate: $0.06 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, readOnlyHint=false, and openWorldHint=true. The description adds only a billing note ($0.06 estimate) but omits the critical behavioral trait that this creates an asynchronous task whose results must be retrieved via a fetch tool. Saying it 'provides results' actually misleads about the async nature.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short and reasonably front-loaded, but includes garbled formatting and a trailing billing block. No sentence is wasted, yet the brevity comes at the cost of missing essential workflow information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be described. However, for a complex submit endpoint with many optional nested parameters, the description omits the asynchronous task lifecycle and how results are later obtained, leaving a significant completeness gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is reported at 0% and the top-level 'body' wrapper has no description. The description provides no parameter guidance whatsoever (no cid/place_id/keyword/location/language/depth/sort semantics), so it fails to compensate for the coverage gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the resource ('Reviews element of Google SERPs') but frames it as 'provides results,' which undersells that this is a submit/task-creation endpoint. It does not clearly distinguish it from the sibling get_dataforseo_business_google_reviews_fetch tool, leaving the verb/action ambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of the submit-then-fetch workflow, and no comparison to alternatives like the extended reviews submit or the corresponding fetch tool. The only conditional detail points to external 'List of Locations/Languages' pages rather than usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data. The provided results are specific to the selected location (see the List of Locations) settings.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds return-content detail (address, contacts, rating, working hours) and a usage-based billing estimate ($0.2428 default), which annotations do not cover. However, it says nothing about the POST-with-array-body semantics, single-task vs batch behavior, limits (1000 max), or pagination — notable given the destructive/readOnly=false annotation pair on what is semantically a search.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded and short: the core capability is stated in the first sentence, with supporting detail after. Minor filler ('and other relevant data') and stray zero-width artifacts keep it from a 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value explanation is not required, and the billing note is a plus. But for a tool with an undocumented array body, destructive/readOnly=false annotations, and many near-duplicate siblings, the description leaves the agent without enough to invoke it confidently or choose it over competitors.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is 0% — the single 'body' parameter has no description at all, and the description only vaguely alludes to 'categories' and 'location' without explaining the required array-of-task-objects structure. The rich nested field docs live in the schema, but the description does nothing to compensate for the missing top-level semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear purpose: it returns business entities listed on Google Maps in the specified categories, with concrete example fields (address, contacts, rating, working hours). This distinguishes it from the review-oriented siblings (Trustpilot, TripAdvisor, Google Reviews), but it never explicitly names or excludes a specific sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance and no routing to alternatives, despite ~25 siblings that overlap heavily (google_gmb_info_live, hotel_info_live, hotel_searches_live, qa_live). The only contextual hint is that results are tied to the selected location, which is a constraint rather than usage direction.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
How many times each of targets has been pinned on Pinterest. Returns type, page_url and pins_count per URL. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Takes a list, so check a whole site's pages in one call. For Pinterest content rather than counts, the pinterest server reads the platform directly.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With annotations present, the description goes well beyond them: it discloses the DataForSEO response envelope (`tasks[0].result`, `tasks[0].status_code`), the critical quirk that a rejected request still returns HTTP 200, and a usage-based cost estimate. It does not reconcile the read-only-looking query with the `readOnlyHint: false` / `destructiveHint: true` annotations or mention rate limits, so it is strong but not exhaustive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the outcome, then the response envelope and error semantics, then the routing note, then pricing; each sentence carries information. The pricing boilerplate is somewhat incidental but it is clearly delimited and useful for a paid API, with no filler prose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so the description need not enumerate return values, yet it usefully names the key fields and the envelope path. Combined with the billing note and batching guidance, an agent has enough to call the tool correctly; the only gap is that the non-read-only/destructive annotations are left unaddressed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is 0% for the single `body` parameter, so the description has to carry meaning; it explains that `targets` is a list of URLs whose pin counts are returned and that list batching is the point of the call. However it never mentions the `tag` field or the 10-URL maximum, both of which live only in the nested schema, so the compensation is partial.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The first sentence gives a specific verb and resource: counting how many times each target URL has been pinned on Pinterest, and it names the exact return fields (`type`, `page_url`, `pins_count`). It also separates itself from the content-oriented sibling/server ('For Pinterest content rather than counts, the pinterest server reads the platform directly'), so an agent can route without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It states when to pick this tool (you want pin counts) versus the alternative that reads platform content, and adds a practical usage hint: 'Takes a list, so check a whole site's pages in one call.' It stops short of stating exclusions such as the 10-target cap or when the other DataForSEO business endpoints would be preferable, so it is clear context without full when/when-not coverage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Intended to return Reddit sharing counts for targets. 🔴 Currently unavailable upstream: it answers status_code 50304, This function temporarily unavailable. Please contact support, with no tasks array at all - the failure is at the top level of the envelope, not inside a task. Measured 2026-08-25. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The Pinterest sibling post_dataforseo_business_social_media_pinterest_live works and costs almost nothing; for Reddit content itself, the reddit server reads the platform directly.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well beyond the annotations by disclosing that the upstream endpoint returns status_code 50304 with no `tasks` array, that the failure is at the envelope top level rather than inside a task, that a rejected request still returns HTTP 200, and that the call is usage-billed (~$0.2428 default estimate). With annotations only covering safety hints, this is unusually rich behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with purpose, then the critical unavailability warning, then envelope semantics and alternatives. Sentences are dense but each carries signal; the pricing HTML-comment block is boilerplate and adds mild noise.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with an output schema and annotations, the description supplies everything the schema cannot: current upstream availability, error-envelope semantics, HTTP status behavior, cost, and alternative routes. Nothing needed to decide whether and how to call it is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The top-level `body` wrapper is undocumented (coverage metric reads 0%), but the nested schema does describe `tag` and `targets` in detail, and the description adds the cost-relevant fact that billing is per URL in `targets`. It does not explain the task-array wrapper shape, which leaves a small gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'return Reddit sharing counts for `targets`', and immediately qualifies it with the operational status. It also differentiates itself from the Pinterest sibling and from the reddit server tool, so an agent can route correctly without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit when-not-to-use guidance ('Currently unavailable upstream', 50304 error, measured 2026-08-25) and names two concrete alternatives: the Pinterest sibling for working social-media counts and the reddit server for Reddit content itself. This is exactly the routing information an agent needs.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides results from the “Reviews” element on the Tripadvisor platform. The results are specific to the URL path or keyword you indicate, and and the selected location (see the List of Locations).
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, idempotentHint=false, and openWorldHint=true. The description adds a genuinely useful cost signal (default request estimate $0.2428, usage-based billing, account-specific pricing) that the annotations do not cover. It does not, however, disclose that this is an asynchronous task-creation endpoint whose output must be polled/fetched, and its 'provides results' framing undersells the billable write action the annotations flag.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short and front-loads the resource description, and the pricing note is compact. But it contains duplicated words ('and and'), leading zero-width characters, and spends its budget on a retrieval description rather than the task-submission semantics, so it is under-specified rather than truly economical.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value explanation is not required. However, for a submit endpoint with a large, nested task body and no required top-level parameters, the description omits the critical fact that a task is created and results are retrieved asynchronously via the fetch sibling, plus the billing implications per task. It is incomplete for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is reported at 0% at the top level (the single 'body' array parameter), so the description must compensate. It only alludes to 'the URL path or keyword you indicate' and 'the selected location,' adding no syntax, defaults, mutually-exclusive requirement rules, or per-field meaning beyond what the schema already documents at the nested level. Compensation is weak.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The name and title identify the resource (Tripadvisor Reviews) and the operation class (submit/setting tasks), and the description names the platform element. However, the body says the endpoint 'provides results,' which describes a retrieval rather than a task-submission operation and blurs the distinction from the sibling get_dataforseo_business_tripadvisor_reviews_fetch. The vague purpose is stated, but the write-vs-read nature of this endpoint is left ambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no when-to-use guidance and never mentions the sibling get_dataforseo_business_tripadvisor_reviews_fetch that retrieves the queued results. There is no note about the keyword/url_path exclusivity or location requirement that determines whether a call can succeed, so an agent receives no routing or prerequisite guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides a list of business profiles listed on the Tripadvisor platform. The returned results are relevant to the specified keyword and the selected location (see the List of Locations).
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=false and destructiveHint=true, so the agent knows this is a mutating write, but the description's 'provides a list' wording implies a read and never states that the call only enqueues a task whose results arrive later. The one genuinely useful addition is the usage-based billing estimate ($0.2428), which is real behavioral context, but the async/task nature is undisclosed. The read-like framing runs counter to the destructive-write annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences plus an injected pricing note, front-loaded and free of filler. Its brevity is appropriate, though the compactness comes at the cost of the missing behavioral detail rather than being maximal efficiency.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, but this is a task-submission tool with a nested array body and it never explains the enqueue-then-fetch workflow, the effectively-required keyword field, or location prerequisites. For a destructive POST endpoint the description is materially incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The top-level 'body' parameter carries no description (0% coverage), but the nested item properties in the schema extensively document keyword, depth, location_code/name, priority, pingback and postback. The description itself adds nothing about parameters, so the schema does the heavy lifting; baseline 3 is appropriate given the inner properties are well specified even though the wrapper is not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the domain (Tripadvisor business profiles filtered by keyword and location) which is reasonably specific. However, it uses the verb 'provides a list,' which frames the tool as a synchronous read, while the tool name says 'submit' and the action is actually creating an asynchronous task. The mismatch between the stated verb and the true operation, plus no differentiation from the get_..._tripadvisor_search_fetch sibling, keeps this at a vague-purpose level.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no indication that this submits a task to be retrieved later via get_dataforseo_business_tripadvisor_search_fetch, and no mention of prerequisites or exclusions. The agent is given subject matter but no routing logic among the many sibling submit/fetch tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides reviews published on the Trustpilot platform for the local establishment specified in the domain field.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly=false, destructive=true, idempotent=false and openWorld=true, so the safety profile is covered. The description adds only a pricing/estimate note and omits the crucial behavior that this creates an asynchronous task whose results are retrieved later via fetch or delivered to pingback/postback URLs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short and front-loads the purpose sentence ahead of the boilerplate pricing block. However, it opens with stray zero-width characters and spends its second half on generic billing text that does not help an agent invoke the tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need no explanation, but for an async task-submission endpoint the description should still convey that it queues a task, returns a task id, and that results arrive via fetch/postback. None of that is present, leaving the agent without what it needs to use the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The top-level 'body' parameter has 0% schema description coverage, but its nested properties (domain, depth, sort_by, priority, pingback_url, postback_url) are extensively documented in the schema. The description only ties the request to 'the domain field,' which adds a small but real link to the required establishment domain.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description says the endpoint 'provides reviews published on the Trustpilot platform,' framing it as a retrieval operation, but the tool is a POST task-submission endpoint (as the name and title 'Setting...Tasks' indicate). It also fails to distinguish itself from the sibling get_dataforseo_business_trustpilot_reviews_fetch, which is the actual retrieval counterpart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this tool, no mention of prerequisites, and no routing to/from the fetch or search siblings. The agent is left to infer the submit-then-fetch workflow entirely on its own.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the specified keyword.
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare this is a non-read-only, non-idempotent, destructive, open-world operation, so the safety profile is covered. The description adds a genuinely useful pricing estimate, but it omits the critical behavioral fact that this registers an async task (with optional pingback/postback delivery) rather than returning data immediately, and it arguably implies an immediate read.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences plus a pricing block, front-loaded and free of padding. The size is appropriate; the only weakness is that the sentences describe the wrong action rather than wasting space.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return format needn't be explained, but for a task-submission endpoint amid dozens of submit/fetch siblings the description is incomplete: it fails to convey the async submit-then-fetch workflow, task-creation semantics, or the existence of the paired fetch tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single top-level 'body' parameter has no description (0% coverage), and the tool description says nothing about keyword, depth, priority, or delivery options. The agent must dig into the nested item schema, which does document these fields richly, so the description itself adds no compensating value.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description identifies a clear resource ('business profiles listed on the Trustpilot platform' matched to a keyword), but the verb is misleading: this is a *submit* tool that creates an asynchronous task, yet the description frames it as an endpoint that 'provides a list' of results directly. It never distinguishes itself from the sibling get_dataforseo_business_trustpilot_search_fetch, which is the tool that actually returns the profiles.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this submit tool versus the fetch sibling, no mention that results must be retrieved separately, and no prerequisites or exclusions. The agent is left to infer the entire workflow from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Discover AIsa tools and Plans for external data or actions. Skip tasks that only need supplied content or general knowledge. For multi-step tasks, search the full goal before decomposing it. Use English; put identifiers in known_fields. If has_full_schema=false, call batch_get_schema. Next call batch_quote, not batch_use. Do not search for standalone rewriting, translation, summarization, formatting, or calculations on supplied content. For one capability, use an atomic query. Select a matching capability, date window, and metric. A Plan may cover only part of the task; assess its purpose and follow next_steps_guidance.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of additional direct tool candidates. | |
| query | Yes | Natural-language capability or task to discover. | |
| category | No | Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.) | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. | |
| known_fields | No | Known values such as ticker, URL, provider, or identifier that improve retrieval. | |
| provider_filters | No | Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown. |
| Name | Required | Description |
|---|---|---|
| plan | No | |
| tools | Yes | |
| search_id | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| retrieval_mode | No | |
| next_steps_guidance | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds workflow behavior the annotations cannot: the has_full_schema flag gates a required batch_get_schema call, and the next step after search is batch_quote, not batch_use. It stops short of disclosing retrieval limits or catalog breadth that would push it to a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is a dense run of imperatives rather than flowing prose, but each sentence carries a distinct rule (scope, language, workflow branch, negative cases, result interpretation) and the most important scoping guidance is front-loaded. Slightly more compression would help.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, the description need not explain return values, and it correctly avoids doing so while still referencing the output fields that drive the workflow (has_full_schema, next_steps_guidance). A mutation-free, well-annotated search tool is adequately covered, though catalog scope ('AIsa-only', no external providers) could be stated more explicitly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the structured baseline is 3. The description adds genuine meaning beyond the schema by telling the agent to write the query in English and to place tickers, URLs, providers, or identifiers in known_fields, which is non-obvious routing guidance for a nested free-form object.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: 'Discover AIsa tools and Plans for external data or actions.' It also separates this discovery step from the sibling execution tools by naming batch_get_schema, batch_quote, and batch_use and stating when each follows, so an agent can place it in the workflow without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use ('tasks needing external data or actions'), when-not ('tasks that only need supplied content or general knowledge'; no standalone rewriting, translation, summarization, formatting, or calculations), and named alternatives (batch_get_schema when has_full_schema=false, batch_quote rather than batch_use). It also specifies query language and atomic-query style, leaving little to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deprecated, use batch_use instead
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | No | Arguments matching input_schema / arguments_schema | |
| search_id | No | search_id from the search that found this operation | |
| operation_id | Yes | operation_id as returned by search | |
| max_price_usd | No | Refuse the call before any spend if its quoted price is above this many USD |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, and openWorldHint=true, so the agent knows this is a state-changing, open-world operation. The description adds only the deprecation status and says nothing about what gets mutated, spend behavior (despite a max_price_usd param), or authorization needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single clause with zero waste; the deprecation notice and the replacement are front-loaded. It is terse by design for a deprecated endpoint, though it is under-specified rather than optimally efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Has an output schema and annotations, which reduces the burden, but a 4-parameter operation tool with a deprecation notice gives no information about what it executes or whether it remains functional. For an agent deciding between this and batch_use, the description is thin.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all four parameters (operation_id, arguments, search_id, max_price_usd) are already documented in the schema. The description adds no parameter meaning on top, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does — no verb or resource. It only labels the tool as deprecated and points to a replacement, leaving the actual capability ('Run an AIsa operation' from the title) unexplained. An agent must infer the purpose from the title and schema alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly routes the agent to the alternative ('use batch_use instead'), which is exactly the guidance needed for a deprecated tool. It doesn't explain when, if ever, this tool should still be called (e.g., during a migration window), so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
accountget_detailspost_dataforseo_business_google_extended_reviews_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "cid": "17626775537598922320",
- "language_name": "english",
- "location_name": "London,England,United Kingdom"
- }
- ],
- "properties": {
- "cid": {
- "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
- "type": "string"
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>1000</code><p><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>three times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "place_id": {
- "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "cid": {
+ "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>1000</code><p><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>three times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "place_id": {
+ "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_gmb_info_live1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "keyword": "RustyBrick, Inc.",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_gmb_updates_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "keyword": "RustyBrick, Inc.",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of updates in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row<br><strong>please note that Google returns 4490 updates maximum</strong><br>default value: <code>10</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;this field can also be used to pass <code>cid</code> (unique, google-defined id of the business entity) or <code>place_id</code> (identifier of the business entity in Google Maps) parameters<br>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of updates in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row<br><strong>please note that Google returns 4490 updates maximum</strong><br>default value: <code>10</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;this field can also be used to pass <code>cid</code> (unique, google-defined id of the business entity) or <code>place_id</code> (identifier of the business entity in Google Maps) parameters<br>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_hotel_info_live1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "hotel_identifier": "CgoI-KWyzenM_MV3EAE",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "adults": {
- "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "check_in": {
- "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>the value must not be earlier than today's date<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "check_out": {
- "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "children": {
- "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "currency": {
- "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "hotel_identifier": {
- "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "load_prices_by_dates": {
- "description": "<em>load hotel stay prices by dates</em><br>optional field<br>if you specify this parameter with <code>true</code>, the response will include the <code>prices_by_dates</code> array with hotel stay prices divided by dates<br>if you use this parameter, you will be charged <strong>double the base price for a request</strong>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude, longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "prices_date_range": {
- "description": "<em>predefined period for retrieving daily price data</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if the <code>prices_start_date </code>is not specified, the start date is set to <code>check_in</code> date<br>possible values: <code>month</code>, <code>three_months</code>, <code>six_months</code>, <code>year</code><br>default value: <code>month</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "prices_end_date": {
- "description": "<em>end date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, you will get prices by date for the month <br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-21</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "prices_start_date": {
- "description": "<em>start date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, the start date is set to <code>check_in</code> date<br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-20</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>the value must not be earlier than today's date<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hotel_identifier": {
+ "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "load_prices_by_dates": {
+ "description": "<em>load hotel stay prices by dates</em><br>optional field<br>if you specify this parameter with <code>true</code>, the response will include the <code>prices_by_dates</code> array with hotel stay prices divided by dates<br>if you use this parameter, you will be charged <strong>double the base price for a request</strong>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude, longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "prices_date_range": {
+ "description": "<em>predefined period for retrieving daily price data</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if the <code>prices_start_date </code>is not specified, the start date is set to <code>check_in</code> date<br>possible values: <code>month</code>, <code>three_months</code>, <code>six_months</code>, <code>year</code><br>default value: <code>month</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "prices_end_date": {
+ "description": "<em>end date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, you will get prices by date for the month <br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-21</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "prices_start_date": {
+ "description": "<em>start date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, the start date is set to <code>check_in</code> date<br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-20</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_hotel_info_live_html1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "adults": {
- "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "check_in": {
- "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "check_out": {
- "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "children": {
- "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "currency": {
- "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "hotel_identifier": {
- "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post/\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-hotels-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hotel_identifier": {
+ "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post/\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-hotels-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_hotel_searches_live1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "adults": 2,
- "check_in": "2023-06-01",
- "check_out": "2023-06-30",
- "children": [
- "14"
- ],
- "currency": "USD",
- "keyword": "cheap hotel",
- "language_code": "en",
- "location_name": "New York,New York,United States",
- "priority": 2,
- "sort_by": "highest_rating",
- "tag": "example"
- }
- ],
- "properties": {
- "adults": {
- "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, the default value of <code>2</code> will be applied;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>example:<br><code>1</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "amenities": {
- "description": "<em>hotel amenities</em><br>optional field<br>you can use this field to specify different hotel amenities<br>example:<br><code> [<br> \"free_parking\",<br> \"pets_allowed\"<br> ]<br></code><br>possible values:<br>`\"air_conditioning\",<br>\"all_inclusive_available\",<br>\"bar\",<br>\"free_breakfast\",<br>\"fitness_center\",<br>\"kid_friendly\",<br>\"free_parking\",<br>\"pets_allowed\",<br>\"pool\",<br>\"restaurant\",<br>\"room_service\",<br>\"spa\",<br>\"free_wifi\",<br>\"parking\",<br>\"indoor_pool\",<br>\"outdoor_pool\",<br>\"wheelchair_accessible\",<br>\"beach_access\"`",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "check_in": {
- "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot precede the today's date",
- "type": [
- "string",
- "null"
- ]
- },
- "check_out": {
- "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days",
- "type": [
- "string",
- "null"
- ]
- },
- "children": {
- "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<br>age of child can be from <code>0</code> to <code>17</code>;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>set the following value if you want to include one 14-year-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-year-old child and one 8-year-old child:<br><code>[13,8]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "currency": {
- "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results in Google Hotels<br>default value: <code>18</code> organic results<br>max value: <code>140</code><br><strong>Note:</strong> your account will be billed per each 18 organic results regardless of paid listings in the response;<br>thus, setting a depth above <code>18</code> may result in additional charges if Google Hotels return more than 18 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
- "type": [
- "integer",
- "null"
- ]
- },
- "free_cancellation": {
- "description": "<em>hotels with a free cancellation</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of hotels with free cancellation of reservations<br>default value: <code>false</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "is_vacation_rentals": {
- "description": "<em>search for vacation rentals</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of vacation rentals instead of hotels<br>default value: <code>false</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br>optional field<br>the keyword you specify is used to search for the list of hotels;<br>if you don't use this field, we will return the list of hotels found in a specified location;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <br><strong>Note:</strong> in order to obtain accurate search results, the location name is appended to the keyword automatically<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code><br><strong>Note:</strong> in order to obtain accurate search results, the <code>location_name</code> you specify will be automatically appended to the keyword",
- "type": "string"
- },
- "max_price": {
- "description": "<em>maximum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>600</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "min_price": {
- "description": "<em>minimum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>100</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "min_rating": {
- "description": "<em>minimum rating</em><br>optional field<br>you can use this field to specify guest rating higher than a certain value<br>example:<br><code>2.5</code>",
- "type": [
- "number",
- "null"
- ]
- },
- "search_this_area": {
- "description": "<em>show hotels from the displayed area</em><br>optional field<br>can take the values: <code>true</code>, <code>false</code><br>default value: <code>true</code><br>if set to <code>false</code> the <code>search_this_area</code> mode will be turned off<br><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, the <code>location_name</code> won't be appended to the <code>keyword</code> during search<br>learn more about this parameter <a href=\"https://dataforseo.com/help-center/how-to-use-search_this_area-parameter-in-google-hotel-searches\" target=\"_blank\">on our Help Center</a>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>relevance</code> – sort by most relevant<br><code>lowest_price</code> – sort by the lowest price<br><code>highest_rating</code> – sort by highest rating<br><code>most_reviewed</code> – sort by most reviewed<br>default value: <code>relevance</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "stars": {
- "description": "<em>hotel stars</em><br>optional field<br>set this field to <code>[5]</code> if you want to get the list of 5-star hotels only<br>example:<br><code>[3,4,5]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, the default value of <code>2</code> will be applied;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "amenities": {
+ "description": "<em>hotel amenities</em><br>optional field<br>you can use this field to specify different hotel amenities<br>example:<br><code> [<br> \"free_parking\",<br> \"pets_allowed\"<br> ]<br></code><br>possible values:<br>`\"air_conditioning\",<br>\"all_inclusive_available\",<br>\"bar\",<br>\"free_breakfast\",<br>\"fitness_center\",<br>\"kid_friendly\",<br>\"free_parking\",<br>\"pets_allowed\",<br>\"pool\",<br>\"restaurant\",<br>\"room_service\",<br>\"spa\",<br>\"free_wifi\",<br>\"parking\",<br>\"indoor_pool\",<br>\"outdoor_pool\",<br>\"wheelchair_accessible\",<br>\"beach_access\"`",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot precede the today's date",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<br>age of child can be from <code>0</code> to <code>17</code>;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>set the following value if you want to include one 14-year-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-year-old child and one 8-year-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results in Google Hotels<br>default value: <code>18</code> organic results<br>max value: <code>140</code><br><strong>Note:</strong> your account will be billed per each 18 organic results regardless of paid listings in the response;<br>thus, setting a depth above <code>18</code> may result in additional charges if Google Hotels return more than 18 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "free_cancellation": {
+ "description": "<em>hotels with a free cancellation</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of hotels with free cancellation of reservations<br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "is_vacation_rentals": {
+ "description": "<em>search for vacation rentals</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of vacation rentals instead of hotels<br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br>optional field<br>the keyword you specify is used to search for the list of hotels;<br>if you don't use this field, we will return the list of hotels found in a specified location;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <br><strong>Note:</strong> in order to obtain accurate search results, the location name is appended to the keyword automatically<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code><br><strong>Note:</strong> in order to obtain accurate search results, the <code>location_name</code> you specify will be automatically appended to the keyword",
+ "type": "string"
+ },
+ "max_price": {
+ "description": "<em>maximum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>600</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "min_price": {
+ "description": "<em>minimum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>100</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "min_rating": {
+ "description": "<em>minimum rating</em><br>optional field<br>you can use this field to specify guest rating higher than a certain value<br>example:<br><code>2.5</code>",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "search_this_area": {
+ "description": "<em>show hotels from the displayed area</em><br>optional field<br>can take the values: <code>true</code>, <code>false</code><br>default value: <code>true</code><br>if set to <code>false</code> the <code>search_this_area</code> mode will be turned off<br><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, the <code>location_name</code> won't be appended to the <code>keyword</code> during search<br>learn more about this parameter <a href=\"https://dataforseo.com/help-center/how-to-use-search_this_area-parameter-in-google-hotel-searches\" target=\"_blank\">on our Help Center</a>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>relevance</code> – sort by most relevant<br><code>lowest_price</code> – sort by the lowest price<br><code>highest_rating</code> – sort by highest rating<br><code>most_reviewed</code> – sort by most reviewed<br>default value: <code>relevance</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "stars": {
+ "description": "<em>hotel stars</em><br>optional field<br>set this field to <code>[5]</code> if you want to get the list of 5-star hotels only<br>example:<br><code>[3,4,5]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_qa_live1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "keyword": "The Last Bookstore",
- "language_code": "en",
- "location_name": "Los Angeles,California,United States"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>100</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>100</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_reviews_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "depth": 50,
- "keyword": "hedonism wines",
- "language_name": "English",
- "location_name": "London,England,United Kingdom",
- "sort_by": "highest_rating"
- }
- ],
- "properties": {
- "cid": {
- "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
- "type": "string"
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row<br>default value: <code>10</code><br>maximum value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "place_id": {
- "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>newest</code> – sort by newest first<br><code>highest_rating</code> – sort by highest rating<br><code>lowest_rating</code> – sort by lowest rating<br><code>relevant</code> – sort by relevance<br>default value: <code>relevant</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "cid": {
+ "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row<br>default value: <code>10</code><br>maximum value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "place_id": {
+ "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>newest</code> – sort by newest first<br><code>highest_rating</code> – sort by highest rating<br><code>lowest_rating</code> – sort by lowest rating<br><code>relevant</code> – sort by relevance<br>default value: <code>relevant</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_listings_search_live3 fields changedInput schema / $defsAdded value: +{
+ "Provider0A3E90081762_AisaDataforseoFilterJsonValue": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "additionalProperties": {
+ "$ref": "#/$defs/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
+ },
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ {
+ "items": {
+ "$ref": "#/$defs/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
+ },
+ "type": "array"
+ }
+ ],
+ "description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
+ }
+}Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "properties": {
+ "categories": {
+ "description": "<em>business categories</em><br>optional field<br>the categories you specify are used to search for business listings;<br>if you don't use this field, we will return business listings found in the specified location;<br>you can specify <strong>up to 10 categories</strong>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "description": {
+ "description": "<em>description of the element in SERP</em><br>optional field<br>the description of the business entity for which the results are collected;<br>can contain up to 200 characters",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "filters": {
+ "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><br>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/business_listings/available_filters</code><br>The full list of possible filters is available <a href=\"/v3/business_data/business_listings/filters\" rel=\"noopener noreferrer\" target=\"_blank\">here.</a>n",
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "additionalProperties": {
+ "$ref": "#/$defs/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
+ },
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ {
+ "items": {
+ "$ref": "#/$defs/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
+ },
+ "type": "array"
+ }
+ ],
+ "description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "is_claimed": {
+ "description": "<em>indicates whether the business is verified by its owner on Google Maps</em><br>optional field",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "limit": {
+ "description": "<em>the maximum number of returned businesses</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br>optional field<br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the value of <em>\"radius\"</em> is specified in kilometres (km)<br>the minimum value for <em>\"radius\"</em>: <code>1</code><br>the maximum value for <em>\"radius\"</em>: <code>100000</code><br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code><br>learn more about how to set location parameters in this API on our <a href=\"https://dataforseo.com/help-center/how-to-specify-location-settings-in-business-listings-api\" target=\"_blank\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "offset": {
+ "description": "<em>offset in the results array of returned businesses</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "offset_token": {
+ "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "order_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"rating.value,desc\"]</code><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"rating.value,desc\",\"rating.votes_count,desc\"]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "title": {
+ "description": "<em>title of the element in SERP</em><br>optional field<br>the name of the business entity for which the results are collected;<br>can contain up to 200 characters",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / oneOfRemoved value: -[
- {
- "example": [
- {
- "categories": [
- "pizza_restaurant"
- ],
- "description": "pizza",
- "filters": [
- [
- "rating.value",
- ">",
- 3
- ]
- ],
- "is_claimed": true,
- "limit": 3,
- "location_coordinate": "53.476225,-2.243572,10",
- "order_by": [
- "rating.value,desc"
- ],
- "title": "pizza"
- }
- ],
- "properties": {
- "categories": {
- "description": "<em>business categories</em><br>optional field<br>the categories you specify are used to search for business listings;<br>if you don't use this field, we will return business listings found in the specified location;<br>you can specify <strong>up to 10 categories</strong>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "description": {
- "description": "<em>description of the element in SERP</em><br>optional field<br>the description of the business entity for which the results are collected;<br>can contain up to 200 characters",
- "type": [
- "string",
- "null"
- ]
- },
- "filters": {
- "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><br>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/business_listings/available_filters</code><br>The full list of possible filters is available <a href=\"/v3/business_data/business_listings/filters\" rel=\"noopener noreferrer\" target=\"_blank\">here.</a>n",
- "items": {
- "type": [
- "object",
- "null"
- ]
- },
- "type": [
- "array",
- "null"
- ]
- },
- "is_claimed": {
- "description": "<em>indicates whether the business is verified by its owner on Google Maps</em><br>optional field",
- "type": [
- "boolean",
- "null"
- ]
- },
- "limit": {
- "description": "<em>the maximum number of returned businesses</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br>optional field<br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the value of <em>\"radius\"</em> is specified in kilometres (km)<br>the minimum value for <em>\"radius\"</em>: <code>1</code><br>the maximum value for <em>\"radius\"</em>: <code>100000</code><br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code><br>learn more about how to set location parameters in this API on our <a href=\"https://dataforseo.com/help-center/how-to-specify-location-settings-in-business-listings-api\" target=\"_blank\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "offset": {
- "description": "<em>offset in the results array of returned businesses</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead",
- "type": [
- "integer",
- "null"
- ]
- },
- "offset_token": {
- "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "order_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"rating.value,desc\"]</code><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"rating.value,desc\",\"rating.votes_count,desc\"]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "title": {
- "description": "<em>title of the element in SERP</em><br>optional field<br>the name of the business entity for which the results are collected;<br>can contain up to 200 characters",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]post_dataforseo_business_tripadvisor_reviews_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "location_code": 1003854,
- "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
- "tag": "some_string_123",
- "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP;<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;<br>default value: <code>10</code>;<br>max value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field if you do not specify <code>url_path</code></strong><br>the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<em><br></em><code class=\"long-string\">en</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "string",
- "null"
- ]
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<br><code class=\"long-string\">English</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "string",
- "null"
- ]
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
- "type": "integer"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "months": {
- "description": "<em>filter by months when a traveler made a visit</em><br>optional field<br>possible values: <code>january</code>, <code>february</code>, <code>march</code>, <code>april</code>, <code>may</code>, <code>april</code>, <code>june</code>, <code>july</code>, <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code>, <code>december</code><br>you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "ratings": {
- "description": "<em>Tripadvisor traveler rating for a place of interest</em><br>optional field<br>rating based on the written reviews by a traveler after they visited a place.<br>possible values: <code>excellent</code>, <code>very_good</code>, <code>average</code>, <code>poor</code>, <code>terrible</code><br>you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code><br><code>detailed_reviews</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "translate_reviews": {
- "description": "<em>translate reviews according to the URL path</em><br>optional field<br>if set to <code>true</code>, returned reviews will be translated to the language matching the specified <code>url_path</code>;<br>for example, if <code>url_path</code> contains <code>tripadvisor.it</code> and <code>translate_reviews</code> is <code>true</code>, reviews will be translated to the Italian language;<br>default value: <code>true</code><br>you can learn more about how reviews are translated in <a href=\"https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api\" rel=\"noopener noreferrer\" target=\"_blank\">this Help Center article</a>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "url_path": {
- "description": "<em>URL path of the business entity</em><br><strong>required field if you do not specify <code>keyword</code></strong><br>URL path to the Tripadvisor page of the business entity;<br>examples:<br><code>Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code><br><code>https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code>",
- "type": "string"
- },
- "visit_type": {
- "description": "<em>filter by type of travelers who left a review</em><br>optional field<br>possible values: <code>families</code>, <code>couples</code>, <code>solo</code>, <code>business</code>, <code>friends</code><br>you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP;<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;<br>default value: <code>10</code>;<br>max value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you do not specify <code>url_path</code></strong><br>the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<em><br></em><code class=\"long-string\">en</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<br><code class=\"long-string\">English</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "months": {
+ "description": "<em>filter by months when a traveler made a visit</em><br>optional field<br>possible values: <code>january</code>, <code>february</code>, <code>march</code>, <code>april</code>, <code>may</code>, <code>april</code>, <code>june</code>, <code>july</code>, <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code>, <code>december</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "ratings": {
+ "description": "<em>Tripadvisor traveler rating for a place of interest</em><br>optional field<br>rating based on the written reviews by a traveler after they visited a place.<br>possible values: <code>excellent</code>, <code>very_good</code>, <code>average</code>, <code>poor</code>, <code>terrible</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code><br><code>detailed_reviews</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "translate_reviews": {
+ "description": "<em>translate reviews according to the URL path</em><br>optional field<br>if set to <code>true</code>, returned reviews will be translated to the language matching the specified <code>url_path</code>;<br>for example, if <code>url_path</code> contains <code>tripadvisor.it</code> and <code>translate_reviews</code> is <code>true</code>, reviews will be translated to the Italian language;<br>default value: <code>true</code><br>you can learn more about how reviews are translated in <a href=\"https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api\" rel=\"noopener noreferrer\" target=\"_blank\">this Help Center article</a>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "url_path": {
+ "description": "<em>URL path of the business entity</em><br><strong>required field if you do not specify <code>keyword</code></strong><br>URL path to the Tripadvisor page of the business entity;<br>examples:<br><code>Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code><br><code>https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code>",
+ "type": "string"
+ },
+ "visit_type": {
+ "description": "<em>filter by type of travelers who left a review</em><br>optional field<br>possible values: <code>families</code>, <code>couples</code>, <code>solo</code>, <code>business</code>, <code>friends</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_tripadvisor_search_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "depth": 30,
- "keyword": "pizza",
- "location_code": 1003854
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>210</code><p><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category, company name, or a prominent place;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
- "type": "integer"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>210</code><p><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category, company name, or a prominent place;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_trustpilot_reviews_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "depth": 40,
- "domain": "www.thepearlsource.com"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "domain": {
- "description": "<em>domain of the local establishment</em><br><strong>required field</strong><br>domain of the local establishment on Trustpilot;<br>you can find the domain in the URL of every business listed on Trustpilot<br>example:<br><code>www.thepearlsource.com</code><br><code>https://www.trustpilot.com/review/<strong>www.thepearlsource.com</strong></code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameter</em><br>optional field<br>you can use this field to sort the results;<br>possible sorting parameters:<br><code>recency</code> — most recent reviews first;<br><code>relevance</code> — most relevant reviews first;<br>default value: <code>relevance</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "domain": {
+ "description": "<em>domain of the local establishment</em><br><strong>required field</strong><br>domain of the local establishment on Trustpilot;<br>you can find the domain in the URL of every business listed on Trustpilot<br>example:<br><code>www.thepearlsource.com</code><br><code>https://www.trustpilot.com/review/<strong>www.thepearlsource.com</strong></code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameter</em><br>optional field<br>you can use this field to sort the results;<br>possible sorting parameters:<br><code>recency</code> — most recent reviews first;<br><code>relevance</code> — most relevant reviews first;<br>default value: <code>relevance</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_trustpilot_search_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "depth": 20,
- "keyword": "pizza restaurant"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;<br>default value: <code>10</code>;<br>maximum value: <code>140</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category or company name;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;<br>default value: <code>10</code>;<br>maximum value: <code>140</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category or company name;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_extended_reviews_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "cid": "17626775537598922320",
- "language_name": "english",
- "location_name": "London,England,United Kingdom"
- }
- ],
- "properties": {
- "cid": {
- "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
- "type": "string"
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>1000</code><p><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>three times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "place_id": {
- "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "cid": "17626775537598922320",
+ "language_name": "english",
+ "location_name": "London,England,United Kingdom"
+ }
+ ],
+ "properties": {
+ "cid": {
+ "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>1000</code><p><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>three times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "place_id": {
+ "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_gmb_info_live2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "RustyBrick, Inc.",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_gmb_updates_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "RustyBrick, Inc.",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of updates in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row<br><strong>please note that Google returns 4490 updates maximum</strong><br>default value: <code>10</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;this field can also be used to pass <code>cid</code> (unique, google-defined id of the business entity) or <code>place_id</code> (identifier of the business entity in Google Maps) parameters<br>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of updates in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row<br><strong>please note that Google returns 4490 updates maximum</strong><br>default value: <code>10</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;this field can also be used to pass <code>cid</code> (unique, google-defined id of the business entity) or <code>place_id</code> (identifier of the business entity in Google Maps) parameters<br>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_hotel_info_live2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "hotel_identifier": "CgoI-KWyzenM_MV3EAE",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "adults": {
- "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "check_in": {
- "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>the value must not be earlier than today's date<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "check_out": {
- "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "children": {
- "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "currency": {
- "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "hotel_identifier": {
- "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "load_prices_by_dates": {
- "description": "<em>load hotel stay prices by dates</em><br>optional field<br>if you specify this parameter with <code>true</code>, the response will include the <code>prices_by_dates</code> array with hotel stay prices divided by dates<br>if you use this parameter, you will be charged <strong>double the base price for a request</strong>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude, longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "prices_date_range": {
- "description": "<em>predefined period for retrieving daily price data</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if the <code>prices_start_date </code>is not specified, the start date is set to <code>check_in</code> date<br>possible values: <code>month</code>, <code>three_months</code>, <code>six_months</code>, <code>year</code><br>default value: <code>month</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "prices_end_date": {
- "description": "<em>end date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, you will get prices by date for the month <br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-21</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "prices_start_date": {
- "description": "<em>start date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, the start date is set to <code>check_in</code> date<br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-20</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "hotel_identifier": "CgoI-KWyzenM_MV3EAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>the value must not be earlier than today's date<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hotel_identifier": {
+ "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "load_prices_by_dates": {
+ "description": "<em>load hotel stay prices by dates</em><br>optional field<br>if you specify this parameter with <code>true</code>, the response will include the <code>prices_by_dates</code> array with hotel stay prices divided by dates<br>if you use this parameter, you will be charged <strong>double the base price for a request</strong>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude, longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "prices_date_range": {
+ "description": "<em>predefined period for retrieving daily price data</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if the <code>prices_start_date </code>is not specified, the start date is set to <code>check_in</code> date<br>possible values: <code>month</code>, <code>three_months</code>, <code>six_months</code>, <code>year</code><br>default value: <code>month</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "prices_end_date": {
+ "description": "<em>end date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, you will get prices by date for the month <br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-21</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "prices_start_date": {
+ "description": "<em>start date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, the start date is set to <code>check_in</code> date<br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-20</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_hotel_info_live_html2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "adults": {
- "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "check_in": {
- "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "check_out": {
- "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "children": {
- "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "currency": {
- "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "hotel_identifier": {
- "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post/\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-hotels-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hotel_identifier": {
+ "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post/\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-hotels-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_hotel_searches_live2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "adults": 2,
- "check_in": "2023-06-01",
- "check_out": "2023-06-30",
- "children": [
- "14"
- ],
- "currency": "USD",
- "keyword": "cheap hotel",
- "language_code": "en",
- "location_name": "New York,New York,United States",
- "priority": 2,
- "sort_by": "highest_rating",
- "tag": "example"
- }
- ],
- "properties": {
- "adults": {
- "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, the default value of <code>2</code> will be applied;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>example:<br><code>1</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "amenities": {
- "description": "<em>hotel amenities</em><br>optional field<br>you can use this field to specify different hotel amenities<br>example:<br><code> [<br> \"free_parking\",<br> \"pets_allowed\"<br> ]<br></code><br>possible values:<br>`\"air_conditioning\",<br>\"all_inclusive_available\",<br>\"bar\",<br>\"free_breakfast\",<br>\"fitness_center\",<br>\"kid_friendly\",<br>\"free_parking\",<br>\"pets_allowed\",<br>\"pool\",<br>\"restaurant\",<br>\"room_service\",<br>\"spa\",<br>\"free_wifi\",<br>\"parking\",<br>\"indoor_pool\",<br>\"outdoor_pool\",<br>\"wheelchair_accessible\",<br>\"beach_access\"`",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "check_in": {
- "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot precede the today's date",
- "type": [
- "string",
- "null"
- ]
- },
- "check_out": {
- "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days",
- "type": [
- "string",
- "null"
- ]
- },
- "children": {
- "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<br>age of child can be from <code>0</code> to <code>17</code>;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>set the following value if you want to include one 14-year-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-year-old child and one 8-year-old child:<br><code>[13,8]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "currency": {
- "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results in Google Hotels<br>default value: <code>18</code> organic results<br>max value: <code>140</code><br><strong>Note:</strong> your account will be billed per each 18 organic results regardless of paid listings in the response;<br>thus, setting a depth above <code>18</code> may result in additional charges if Google Hotels return more than 18 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
- "type": [
- "integer",
- "null"
- ]
- },
- "free_cancellation": {
- "description": "<em>hotels with a free cancellation</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of hotels with free cancellation of reservations<br>default value: <code>false</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "is_vacation_rentals": {
- "description": "<em>search for vacation rentals</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of vacation rentals instead of hotels<br>default value: <code>false</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br>optional field<br>the keyword you specify is used to search for the list of hotels;<br>if you don't use this field, we will return the list of hotels found in a specified location;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <br><strong>Note:</strong> in order to obtain accurate search results, the location name is appended to the keyword automatically<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code><br><strong>Note:</strong> in order to obtain accurate search results, the <code>location_name</code> you specify will be automatically appended to the keyword",
- "type": "string"
- },
- "max_price": {
- "description": "<em>maximum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>600</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "min_price": {
- "description": "<em>minimum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>100</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "min_rating": {
- "description": "<em>minimum rating</em><br>optional field<br>you can use this field to specify guest rating higher than a certain value<br>example:<br><code>2.5</code>",
- "type": [
- "number",
- "null"
- ]
- },
- "search_this_area": {
- "description": "<em>show hotels from the displayed area</em><br>optional field<br>can take the values: <code>true</code>, <code>false</code><br>default value: <code>true</code><br>if set to <code>false</code> the <code>search_this_area</code> mode will be turned off<br><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, the <code>location_name</code> won't be appended to the <code>keyword</code> during search<br>learn more about this parameter <a href=\"https://dataforseo.com/help-center/how-to-use-search_this_area-parameter-in-google-hotel-searches\" target=\"_blank\">on our Help Center</a>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>relevance</code> – sort by most relevant<br><code>lowest_price</code> – sort by the lowest price<br><code>highest_rating</code> – sort by highest rating<br><code>most_reviewed</code> – sort by most reviewed<br>default value: <code>relevance</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "stars": {
- "description": "<em>hotel stars</em><br>optional field<br>set this field to <code>[5]</code> if you want to get the list of 5-star hotels only<br>example:<br><code>[3,4,5]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "adults": 2,
+ "check_in": "2023-06-01",
+ "check_out": "2023-06-30",
+ "children": [
+ "14"
+ ],
+ "currency": "USD",
+ "keyword": "cheap hotel",
+ "language_code": "en",
+ "location_name": "New York,New York,United States",
+ "priority": 2,
+ "sort_by": "highest_rating",
+ "tag": "example"
+ }
+ ],
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, the default value of <code>2</code> will be applied;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "amenities": {
+ "description": "<em>hotel amenities</em><br>optional field<br>you can use this field to specify different hotel amenities<br>example:<br><code> [<br> \"free_parking\",<br> \"pets_allowed\"<br> ]<br></code><br>possible values:<br>`\"air_conditioning\",<br>\"all_inclusive_available\",<br>\"bar\",<br>\"free_breakfast\",<br>\"fitness_center\",<br>\"kid_friendly\",<br>\"free_parking\",<br>\"pets_allowed\",<br>\"pool\",<br>\"restaurant\",<br>\"room_service\",<br>\"spa\",<br>\"free_wifi\",<br>\"parking\",<br>\"indoor_pool\",<br>\"outdoor_pool\",<br>\"wheelchair_accessible\",<br>\"beach_access\"`",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot precede the today's date",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<br>age of child can be from <code>0</code> to <code>17</code>;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>set the following value if you want to include one 14-year-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-year-old child and one 8-year-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results in Google Hotels<br>default value: <code>18</code> organic results<br>max value: <code>140</code><br><strong>Note:</strong> your account will be billed per each 18 organic results regardless of paid listings in the response;<br>thus, setting a depth above <code>18</code> may result in additional charges if Google Hotels return more than 18 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "free_cancellation": {
+ "description": "<em>hotels with a free cancellation</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of hotels with free cancellation of reservations<br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "is_vacation_rentals": {
+ "description": "<em>search for vacation rentals</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of vacation rentals instead of hotels<br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br>optional field<br>the keyword you specify is used to search for the list of hotels;<br>if you don't use this field, we will return the list of hotels found in a specified location;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <br><strong>Note:</strong> in order to obtain accurate search results, the location name is appended to the keyword automatically<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code><br><strong>Note:</strong> in order to obtain accurate search results, the <code>location_name</code> you specify will be automatically appended to the keyword",
+ "type": "string"
+ },
+ "max_price": {
+ "description": "<em>maximum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>600</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "min_price": {
+ "description": "<em>minimum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>100</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "min_rating": {
+ "description": "<em>minimum rating</em><br>optional field<br>you can use this field to specify guest rating higher than a certain value<br>example:<br><code>2.5</code>",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "search_this_area": {
+ "description": "<em>show hotels from the displayed area</em><br>optional field<br>can take the values: <code>true</code>, <code>false</code><br>default value: <code>true</code><br>if set to <code>false</code> the <code>search_this_area</code> mode will be turned off<br><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, the <code>location_name</code> won't be appended to the <code>keyword</code> during search<br>learn more about this parameter <a href=\"https://dataforseo.com/help-center/how-to-use-search_this_area-parameter-in-google-hotel-searches\" target=\"_blank\">on our Help Center</a>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>relevance</code> – sort by most relevant<br><code>lowest_price</code> – sort by the lowest price<br><code>highest_rating</code> – sort by highest rating<br><code>most_reviewed</code> – sort by most reviewed<br>default value: <code>relevance</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "stars": {
+ "description": "<em>hotel stars</em><br>optional field<br>set this field to <code>[5]</code> if you want to get the list of 5-star hotels only<br>example:<br><code>[3,4,5]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_qa_live2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "The Last Bookstore",
- "language_code": "en",
- "location_name": "Los Angeles,California,United States"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>100</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "The Last Bookstore",
+ "language_code": "en",
+ "location_name": "Los Angeles,California,United States"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>100</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_google_reviews_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "depth": 50,
- "keyword": "hedonism wines",
- "language_name": "English",
- "location_name": "London,England,United Kingdom",
- "sort_by": "highest_rating"
- }
- ],
- "properties": {
- "cid": {
- "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
- "type": "string"
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row<br>default value: <code>10</code><br>maximum value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "place_id": {
- "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>newest</code> – sort by newest first<br><code>highest_rating</code> – sort by highest rating<br><code>lowest_rating</code> – sort by lowest rating<br><code>relevant</code> – sort by relevance<br>default value: <code>relevant</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 50,
+ "keyword": "hedonism wines",
+ "language_name": "English",
+ "location_name": "London,England,United Kingdom",
+ "sort_by": "highest_rating"
+ }
+ ],
+ "properties": {
+ "cid": {
+ "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row<br>default value: <code>10</code><br>maximum value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "place_id": {
+ "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>newest</code> – sort by newest first<br><code>highest_rating</code> – sort by highest rating<br><code>lowest_rating</code> – sort by lowest rating<br><code>relevant</code> – sort by relevance<br>default value: <code>relevant</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_listings_search_live2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "categories": [
- "pizza_restaurant"
- ],
- "description": "pizza",
- "filters": [
- [
- "rating.value",
- ">",
- 3
- ]
- ],
- "is_claimed": true,
- "limit": 3,
- "location_coordinate": "53.476225,-2.243572,10",
- "order_by": [
- "rating.value,desc"
- ],
- "title": "pizza"
- }
- ],
- "properties": {
- "categories": {
- "description": "<em>business categories</em><br>optional field<br>the categories you specify are used to search for business listings;<br>if you don't use this field, we will return business listings found in the specified location;<br>you can specify <strong>up to 10 categories</strong>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "description": {
- "description": "<em>description of the element in SERP</em><br>optional field<br>the description of the business entity for which the results are collected;<br>can contain up to 200 characters",
- "type": [
- "string",
- "null"
- ]
- },
- "filters": {
- "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><br>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/business_listings/available_filters</code><br>The full list of possible filters is available <a href=\"/v3/business_data/business_listings/filters\" rel=\"noopener noreferrer\" target=\"_blank\">here.</a>n",
- "items": {
- "type": [
- "object",
- "null"
- ]
- },
- "type": [
- "array",
- "null"
- ]
- },
- "is_claimed": {
- "description": "<em>indicates whether the business is verified by its owner on Google Maps</em><br>optional field",
- "type": [
- "boolean",
- "null"
- ]
- },
- "limit": {
- "description": "<em>the maximum number of returned businesses</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br>optional field<br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the value of <em>\"radius\"</em> is specified in kilometres (km)<br>the minimum value for <em>\"radius\"</em>: <code>1</code><br>the maximum value for <em>\"radius\"</em>: <code>100000</code><br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code><br>learn more about how to set location parameters in this API on our <a href=\"https://dataforseo.com/help-center/how-to-specify-location-settings-in-business-listings-api\" target=\"_blank\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "offset": {
- "description": "<em>offset in the results array of returned businesses</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead",
- "type": [
- "integer",
- "null"
- ]
- },
- "offset_token": {
- "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "order_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"rating.value,desc\"]</code><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"rating.value,desc\",\"rating.votes_count,desc\"]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "title": {
- "description": "<em>title of the element in SERP</em><br>optional field<br>the name of the business entity for which the results are collected;<br>can contain up to 200 characters",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "categories": [
+ "pizza_restaurant"
+ ],
+ "description": "pizza",
+ "filters": [
+ [
+ "rating.value",
+ ">",
+ 3
+ ]
+ ],
+ "is_claimed": true,
+ "limit": 3,
+ "location_coordinate": "53.476225,-2.243572,10",
+ "order_by": [
+ "rating.value,desc"
+ ],
+ "title": "pizza"
+ }
+ ],
+ "properties": {
+ "categories": {
+ "description": "<em>business categories</em><br>optional field<br>the categories you specify are used to search for business listings;<br>if you don't use this field, we will return business listings found in the specified location;<br>you can specify <strong>up to 10 categories</strong>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "description": {
+ "description": "<em>description of the element in SERP</em><br>optional field<br>the description of the business entity for which the results are collected;<br>can contain up to 200 characters",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "filters": {
+ "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><br>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/business_listings/available_filters</code><br>The full list of possible filters is available <a href=\"/v3/business_data/business_listings/filters\" rel=\"noopener noreferrer\" target=\"_blank\">here.</a>n",
+ "items": {
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "is_claimed": {
+ "description": "<em>indicates whether the business is verified by its owner on Google Maps</em><br>optional field",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "limit": {
+ "description": "<em>the maximum number of returned businesses</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br>optional field<br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the value of <em>\"radius\"</em> is specified in kilometres (km)<br>the minimum value for <em>\"radius\"</em>: <code>1</code><br>the maximum value for <em>\"radius\"</em>: <code>100000</code><br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code><br>learn more about how to set location parameters in this API on our <a href=\"https://dataforseo.com/help-center/how-to-specify-location-settings-in-business-listings-api\" target=\"_blank\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "offset": {
+ "description": "<em>offset in the results array of returned businesses</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "offset_token": {
+ "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "order_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"rating.value,desc\"]</code><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"rating.value,desc\",\"rating.votes_count,desc\"]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "title": {
+ "description": "<em>title of the element in SERP</em><br>optional field<br>the name of the business entity for which the results are collected;<br>can contain up to 200 characters",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_tripadvisor_reviews_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "location_code": 1003854,
- "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
- "tag": "some_string_123",
- "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP;<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;<br>default value: <code>10</code>;<br>max value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field if you do not specify <code>url_path</code></strong><br>the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<em><br></em><code class=\"long-string\">en</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "string",
- "null"
- ]
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<br><code class=\"long-string\">English</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "string",
- "null"
- ]
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
- "type": "integer"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "months": {
- "description": "<em>filter by months when a traveler made a visit</em><br>optional field<br>possible values: <code>january</code>, <code>february</code>, <code>march</code>, <code>april</code>, <code>may</code>, <code>april</code>, <code>june</code>, <code>july</code>, <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code>, <code>december</code><br>you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "ratings": {
- "description": "<em>Tripadvisor traveler rating for a place of interest</em><br>optional field<br>rating based on the written reviews by a traveler after they visited a place.<br>possible values: <code>excellent</code>, <code>very_good</code>, <code>average</code>, <code>poor</code>, <code>terrible</code><br>you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code><br><code>detailed_reviews</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "translate_reviews": {
- "description": "<em>translate reviews according to the URL path</em><br>optional field<br>if set to <code>true</code>, returned reviews will be translated to the language matching the specified <code>url_path</code>;<br>for example, if <code>url_path</code> contains <code>tripadvisor.it</code> and <code>translate_reviews</code> is <code>true</code>, reviews will be translated to the Italian language;<br>default value: <code>true</code><br>you can learn more about how reviews are translated in <a href=\"https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api\" rel=\"noopener noreferrer\" target=\"_blank\">this Help Center article</a>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "url_path": {
- "description": "<em>URL path of the business entity</em><br><strong>required field if you do not specify <code>keyword</code></strong><br>URL path to the Tripadvisor page of the business entity;<br>examples:<br><code>Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code><br><code>https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code>",
- "type": "string"
- },
- "visit_type": {
- "description": "<em>filter by type of travelers who left a review</em><br>optional field<br>possible values: <code>families</code>, <code>couples</code>, <code>solo</code>, <code>business</code>, <code>friends</code><br>you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "location_code": 1003854,
+ "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
+ "tag": "some_string_123",
+ "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP;<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;<br>default value: <code>10</code>;<br>max value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you do not specify <code>url_path</code></strong><br>the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<em><br></em><code class=\"long-string\">en</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<br><code class=\"long-string\">English</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "months": {
+ "description": "<em>filter by months when a traveler made a visit</em><br>optional field<br>possible values: <code>january</code>, <code>february</code>, <code>march</code>, <code>april</code>, <code>may</code>, <code>april</code>, <code>june</code>, <code>july</code>, <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code>, <code>december</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "ratings": {
+ "description": "<em>Tripadvisor traveler rating for a place of interest</em><br>optional field<br>rating based on the written reviews by a traveler after they visited a place.<br>possible values: <code>excellent</code>, <code>very_good</code>, <code>average</code>, <code>poor</code>, <code>terrible</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code><br><code>detailed_reviews</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "translate_reviews": {
+ "description": "<em>translate reviews according to the URL path</em><br>optional field<br>if set to <code>true</code>, returned reviews will be translated to the language matching the specified <code>url_path</code>;<br>for example, if <code>url_path</code> contains <code>tripadvisor.it</code> and <code>translate_reviews</code> is <code>true</code>, reviews will be translated to the Italian language;<br>default value: <code>true</code><br>you can learn more about how reviews are translated in <a href=\"https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api\" rel=\"noopener noreferrer\" target=\"_blank\">this Help Center article</a>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "url_path": {
+ "description": "<em>URL path of the business entity</em><br><strong>required field if you do not specify <code>keyword</code></strong><br>URL path to the Tripadvisor page of the business entity;<br>examples:<br><code>Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code><br><code>https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code>",
+ "type": "string"
+ },
+ "visit_type": {
+ "description": "<em>filter by type of travelers who left a review</em><br>optional field<br>possible values: <code>families</code>, <code>couples</code>, <code>solo</code>, <code>business</code>, <code>friends</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_tripadvisor_search_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "depth": 30,
- "keyword": "pizza",
- "location_code": 1003854
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>210</code><p><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category, company name, or a prominent place;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
- "type": "integer"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 30,
+ "keyword": "pizza",
+ "location_code": 1003854
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>210</code><p><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category, company name, or a prominent place;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_trustpilot_reviews_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "depth": 40,
- "domain": "www.thepearlsource.com"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "domain": {
- "description": "<em>domain of the local establishment</em><br><strong>required field</strong><br>domain of the local establishment on Trustpilot;<br>you can find the domain in the URL of every business listed on Trustpilot<br>example:<br><code>www.thepearlsource.com</code><br><code>https://www.trustpilot.com/review/<strong>www.thepearlsource.com</strong></code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameter</em><br>optional field<br>you can use this field to sort the results;<br>possible sorting parameters:<br><code>recency</code> — most recent reviews first;<br><code>relevance</code> — most relevant reviews first;<br>default value: <code>relevance</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 40,
+ "domain": "www.thepearlsource.com"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "domain": {
+ "description": "<em>domain of the local establishment</em><br><strong>required field</strong><br>domain of the local establishment on Trustpilot;<br>you can find the domain in the URL of every business listed on Trustpilot<br>example:<br><code>www.thepearlsource.com</code><br><code>https://www.trustpilot.com/review/<strong>www.thepearlsource.com</strong></code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameter</em><br>optional field<br>you can use this field to sort the results;<br>possible sorting parameters:<br><code>recency</code> — most recent reviews first;<br><code>relevance</code> — most relevant reviews first;<br>default value: <code>relevance</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_business_trustpilot_search_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "depth": 20,
- "keyword": "pizza restaurant"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;<br>default value: <code>10</code>;<br>maximum value: <code>140</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category or company name;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 20,
+ "keyword": "pizza restaurant"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;<br>default value: <code>10</code>;<br>maximum value: <code>140</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category or company name;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]batch_get_schemabatch_quotebatch_use18 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / descriptionRemoved value: -"Up to 20 items of {call_id, operation_id, arguments}; steps at the same execution_level of a plan go in one batch"Input schema / properties / calls / items / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / items / additionalPropertiesPrevious value: -trueNew value: +falseInput schema / properties / calls / items / propertiesAdded value: +{
+ "arguments": {
+ "additionalProperties": true,
+ "description": "Strictly schema-compliant arguments using the exact field names and types from this tool's arguments_schema.",
+ "type": "object"
+ },
+ "call_id": {
+ "description": "Caller-chosen identifier unique within this batch.",
+ "maxLength": 128,
+ "minLength": 1,
+ "type": "string"
+ },
+ "tool": {
+ "description": "Exact tool name returned by search or batch_get_schema. Never invent a name.",
+ "minLength": 1,
+ "type": "string"
+ }
+}Input schema / properties / calls / items / requiredAdded value: +[
+ "call_id",
+ "tool",
+ "arguments"
+]Input schema / properties / calls / maxItemsAdded value: +20Input schema / properties / calls / minItemsAdded value: +1Input schema / properties / max_price_usdRemoved value: -{
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Per-call price cap applied to every item"
-}Input schema / properties / search_id / anyOfRemoved value: -[
- {
- "type": "string"
- },
- {
- "type": "null"
- }
-]Input schema / properties / search_id / defaultRemoved value: -nullInput schema / properties / search_id / descriptionPrevious value: -"search_id from the search that found these operations"New value: +"Optional search correlation identifier returned by search."Input schema / properties / search_id / typeAdded value: +"string"Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Output schema / $defsAdded value: +{
+ "jsonValue": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "type": "object"
+ },
+ {
+ "items": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "JSON value returned by the upstream tool."
+ }
+}Output schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Output schema / propertiesAdded value: +{
+ "batch_id": {
+ "type": "string"
+ },
+ "error_count": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "next_steps_guidance": {
+ "description": "Deterministic next-step instructions derived from this result. Not an authorization grant.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "results": {
+ "items": {
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": false,
+ "properties": {
+ "call_id": {
+ "type": "string"
+ },
+ "customer_cost_micros_usd": {
+ "description": "Actual customer charge settled by AIsaServices, in micro-USD. Omitted when the upstream response does not report it.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "data": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "error": {
+ "anyOf": [
+ {
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": false,
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "retryable": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "integer"
+ },
+ "type": {
+ "enum": [
+ "validation",
+ "authentication",
+ "payment",
+ "permission",
+ "rate_limit",
+ "upstream",
+ "timeout",
+ "internal"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "status",
+ "retryable"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "request_id": {
+ "type": "string"
+ },
+ "successful": {
+ "type": "boolean"
+ },
+ "tool": {
+ "type": "string"
+ },
+ "upstream_status": {
+ "description": "HTTP status returned by AIsaServices when a request was dispatched.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "call_id",
+ "tool",
+ "successful",
+ "request_id"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+ },
+ "success_count": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "total_count": {
+ "minimum": 1,
+ "type": "integer"
+ }
+}Output schema / requiredAdded value: +[
+ "session_id",
+ "batch_id",
+ "total_count",
+ "success_count",
+ "error_count",
+ "results",
+ "next_steps_guidance"
+]get_dataforseo_business_google_extended_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_google_gmb_updates_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_google_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_tripadvisor_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_tripadvisor_search_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_trustpilot_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_trustpilot_search_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_details13 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / argumentsRemoved value: -{
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "The arguments the operation would be called with, for a price that reflects them. Keyed by operation_id for a batch, or passed flat for a single operation_id. Routes whose required parameters are validated before pricing have no price without them."
-}Input schema / properties / include_arguments_schemaAdded value: +{
+ "default": true,
+ "description": "Return the complete arguments_schema. Defaults to true.",
+ "type": "boolean"
+}Input schema / properties / include_documentation / descriptionPrevious value: -"Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged."New value: +"Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support."Input schema / properties / include_response_schemaAdded value: +{
+ "default": false,
+ "description": "Return the complete response_schema. Defaults to false.",
+ "type": "boolean"
+}Input schema / properties / operation_idRemoved value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "One operation_id from search"
-}Input schema / properties / operation_idsRemoved value: -{
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Up to 20 operation_ids, for a batch"
-}Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Input schema / properties / toolsAdded value: +{
+ "description": "Exact tool names returned by search whose complete contracts are needed. Never invent tool names.",
+ "items": {
+ "minLength": 1,
+ "pattern": "^\\S(?:.*\\S)?$",
+ "type": "string"
+ },
+ "maxItems": 20,
+ "minItems": 1,
+ "type": "array",
+ "uniqueItems": true
+}Input schema / properties / with_quoteRemoved value: -{
- "default": true,
- "description": "Whether each operation is priced for this account before the answer. One round trip per operation; spends nothing.",
- "type": "boolean"
-}Input schema / requiredAdded value: +[
+ "tools"
+]Output schema / propertiesAdded value: +{
+ "error_count": {
+ "type": "integer"
+ },
+ "next_steps_guidance": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]{1,128}$",
+ "type": "string"
+ },
+ "success_count": {
+ "type": "integer"
+ },
+ "tools": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "arguments_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "canonical_operation_id": {
+ "type": "string"
+ },
+ "documentation": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "error": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "execution_supported": {
+ "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
+ "type": "boolean"
+ },
+ "execution_unsupported_reason": {
+ "description": "Why execution and quoting remain unavailable through this router.",
+ "type": "string"
+ },
+ "idempotent": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "known_pitfalls": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "read_only": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "response_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "side_effects": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "successful": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "successful"
+ ],
+ "type": "object"
+ },
+ "type": "object"
+ },
+ "total_count": {
+ "type": "integer"
+ }
+}Output schema / requiredAdded value: +[
+ "error_count",
+ "next_steps_guidance",
+ "session_id",
+ "success_count",
+ "tools",
+ "total_count"
+]post_dataforseo_business_google_extended_reviews_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "cid": "17626775537598922320",
+ "language_name": "english",
+ "location_name": "London,England,United Kingdom"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "keyword"
- ]
- },
- {
- "required": [
- "cid"
- ]
- },
- {
- "required": [
- "place_id"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "cid": "17626775537598922320",
+ "language_name": "english",
+ "location_name": "London,England,United Kingdom"
+ }
+ ],
+ "properties": {
+ "cid": {
+ "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>1000</code><p><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>three times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "place_id": {
+ "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "cid": {
- "description": "*unique, google-defined id of the business entity* **required field if you don’t specify `keyword` or `place_id`** example: `194604053573767737` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the Google Reviews API",
- "type": "string"
- },
- "depth": {
- "description": "*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row default value: `20` maximum value: `1000` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field if you don’t specify `cid` or `place_id`** the keyword you specify should indicate the name of the local establishment; you can specify **up to 700 characters** in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, **the charge per task will be multiplied by 5** Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) **Note:** if you use this field, your account will be charged **three times the standard rate** for tasks involving the Google Reviews API",
- "type": "string"
- },
- "language_code": {
- "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 the https://api.dataforseo.com/v3/business_data/google/languages example: enn",
- "type": "string"
- },
- "language_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `English`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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 example: 53.476225,-2.243572,200n",
- "type": "string"
- },
- "location_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/locations` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "place_id": {
- "description": "*identifier of the business entity in Google Maps* **required field if you don’t specify `keyword` or `cid`** example: `GhIJQWDl0CIeQUARxks3icF8U8A` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the Google Reviews API",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_gmb_info_live8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "keyword": {
- "description": "keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; 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:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A learn more about the cid and place_id identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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",
- "type": "string"
- },
- "location_name": {
- "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`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_gmb_updates_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of updates in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row<br><strong>please note that Google returns 4490 updates maximum</strong><br>default value: <code>10</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;this field can also be used to pass <code>cid</code> (unique, google-defined id of the business entity) or <code>place_id</code> (identifier of the business entity in Google Maps) parameters<br>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of updates in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row **please note that Google returns 4490 updates maximum** default value: `10`",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field** the keyword you specify should indicate the name of the local establishment you can specify **up to 700 characters** in the `keyword` filed **all %## will be decoded (plus character ‘+’ will be decoded to a space character)** if you need to use the “%” character for your `keyword`, please specify it as “%25”;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 example: `cid:194604053573767737` `place_id:GhIJQWDl0CIeQUARxks3icF8U8A`learn more about the `cid` and `place_id` identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)",
- "type": "string"
- },
- "language_code": {
- "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 the https://api.dataforseo.com/v3/business_data/google/languages example: enn",
- "type": "string"
- },
- "language_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `English`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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 example: 53.476225,-2.243572,200n",
- "type": "string"
- },
- "location_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/locations` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_hotel_info_live8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "hotel_identifier": "CgoI-KWyzenM_MV3EAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "hotel_identifier": "CgoI-KWyzenM_MV3EAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>the value must not be earlier than today's date<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hotel_identifier": {
+ "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "load_prices_by_dates": {
+ "description": "<em>load hotel stay prices by dates</em><br>optional field<br>if you specify this parameter with <code>true</code>, the response will include the <code>prices_by_dates</code> array with hotel stay prices divided by dates<br>if you use this parameter, you will be charged <strong>double the base price for a request</strong>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude, longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "prices_date_range": {
+ "description": "<em>predefined period for retrieving daily price data</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if the <code>prices_start_date </code>is not specified, the start date is set to <code>check_in</code> date<br>possible values: <code>month</code>, <code>three_months</code>, <code>six_months</code>, <code>year</code><br>default value: <code>month</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "prices_end_date": {
+ "description": "<em>end date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, you will get prices by date for the month <br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-21</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "prices_start_date": {
+ "description": "<em>start date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, the start date is set to <code>check_in</code> date<br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-20</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "adults": {
- "description": "*number of adults* optional field if you don’t specify this field, two adults will be used by default example: `1`",
- "type": "integer"
- },
- "check_in": {
- "description": "*check-in date* optional field if you don’t specify this field, tomorrow’s date will be used by default; the value must not be earlier than today’s date date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
- "type": "string"
- },
- "check_out": {
- "description": "*check-out date* optional field if you don’t specify this field, our system will apply the date of two days from now by default; **Note:** the value cannot be less than or equal to `check_in`; the range between `check_in` and `check_out` values cannot exceed 30 days date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
- "type": "string"
- },
- "children": {
- "description": "*number and age of children* optional field if you don’t specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: `[14]` set the following value if you want to include one 13-years-old child and one 8-years-old child: `[13,8]`",
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "currency": {
- "description": "*currency* optional field example: `\"USD\"`",
- "type": "string"
- },
- "hotel_identifier": {
- "description": "*unique hotel identifier* **required field** unique identifier of a hotel entity in Google search; you can obtain the value by making a request to Advanced [Google SERP API](https://docs.dataforseo.com/v3/serp/google/organic/overview.md) (enclosed in the `hotels` element of the response), or the [Hotel Searches endpoint](https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post.md) of Business Data API example: `ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE`",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "load_prices_by_dates": {
- "description": "*load hotel stay prices by dates* optional field if you specify this parameter with `true`, the response will include the `prices_by_dates` array with hotel stay prices divided by dates if you use this parameter, you will be charged **double the base price for a request**",
- "type": "boolean"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_coordinate parameter should be specified in the \"latitude, longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572n",
- "type": "string"
- },
- "location_name": {
- "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`",
- "type": "string"
- },
- "prices_date_range": {
- "description": "*predefined period for retrieving daily price data* optional field to use this parameter, you must specify `load_prices_by_dates` with `true` if the `prices_start_date `is not specified, the start date is set to `check_in` date possible values: `month`, `three_months`, `six_months`, `year` default value: `month`",
- "type": "string"
- },
- "prices_end_date": {
- "description": "*end date to load prices by dates* optional field to use this parameter, you must specify `load_prices_by_dates` with `true` if this parameter is not specified, you will get prices by date for the month date format: `yyyy-mm-dd` example: `2025-05-21`",
- "type": "string"
- },
- "prices_start_date": {
- "description": "*start date to load prices by dates* optional field to use this parameter, you must specify `load_prices_by_dates` with `true` if this parameter is not specified, the start date is set to `check_in` date date format: `yyyy-mm-dd` example: `2025-05-20`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "hotel_identifier"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_hotel_info_live_html8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hotel_identifier": {
+ "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post/\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-hotels-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "adults": {
- "description": "*number of adults* optional field if you don’t specify this field, two adults will be used by default example: `1`",
- "type": "integer"
- },
- "check_in": {
- "description": "*check-in date* optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
- "type": "string"
- },
- "check_out": {
- "description": "*check-out date* optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
- "type": "string"
- },
- "children": {
- "description": "*number and age of children* optional field if you don’t specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: `[14]` set the following value if you want to include one 13-years-old child and one 8-years-old child: `[13,8]`",
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "currency": {
- "description": "*currency* optional field example: `\"USD\"`",
- "type": "string"
- },
- "hotel_identifier": {
- "description": "*unique hotel identifier* **required field** unique identifier of a hotel entity in Google search; you can obtain the value by making a request to Advanced [Google SERP API](https://docs.dataforseo.com/v3/serp/google/organic/overview.md) (enclosed in the `hotels` element of the response), or the [Hotel Searches endpoint](https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post.md) of Business Data API example: `ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE`",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_coordinate parameter should be specified in the \"latitude,longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572n",
- "type": "string"
- },
- "location_name": {
- "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`",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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` array of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "hotel_identifier"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_hotel_searches_live7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "adults": 2,
+ "check_in": "2023-06-01",
+ "check_out": "2023-06-30",
+ "children": [
+ "14"
+ ],
+ "currency": "USD",
+ "keyword": "cheap hotel",
+ "language_code": "en",
+ "location_name": "New York,New York,United States",
+ "priority": 2,
+ "sort_by": "highest_rating",
+ "tag": "example"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "adults": 2,
+ "check_in": "2023-06-01",
+ "check_out": "2023-06-30",
+ "children": [
+ "14"
+ ],
+ "currency": "USD",
+ "keyword": "cheap hotel",
+ "language_code": "en",
+ "location_name": "New York,New York,United States",
+ "priority": 2,
+ "sort_by": "highest_rating",
+ "tag": "example"
+ }
+ ],
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, the default value of <code>2</code> will be applied;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "amenities": {
+ "description": "<em>hotel amenities</em><br>optional field<br>you can use this field to specify different hotel amenities<br>example:<br><code> [<br> \"free_parking\",<br> \"pets_allowed\"<br> ]<br></code><br>possible values:<br>`\"air_conditioning\",<br>\"all_inclusive_available\",<br>\"bar\",<br>\"free_breakfast\",<br>\"fitness_center\",<br>\"kid_friendly\",<br>\"free_parking\",<br>\"pets_allowed\",<br>\"pool\",<br>\"restaurant\",<br>\"room_service\",<br>\"spa\",<br>\"free_wifi\",<br>\"parking\",<br>\"indoor_pool\",<br>\"outdoor_pool\",<br>\"wheelchair_accessible\",<br>\"beach_access\"`",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot precede the today's date",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<br>age of child can be from <code>0</code> to <code>17</code>;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>set the following value if you want to include one 14-year-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-year-old child and one 8-year-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results in Google Hotels<br>default value: <code>18</code> organic results<br>max value: <code>140</code><br><strong>Note:</strong> your account will be billed per each 18 organic results regardless of paid listings in the response;<br>thus, setting a depth above <code>18</code> may result in additional charges if Google Hotels return more than 18 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "free_cancellation": {
+ "description": "<em>hotels with a free cancellation</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of hotels with free cancellation of reservations<br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "is_vacation_rentals": {
+ "description": "<em>search for vacation rentals</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of vacation rentals instead of hotels<br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br>optional field<br>the keyword you specify is used to search for the list of hotels;<br>if you don't use this field, we will return the list of hotels found in a specified location;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <br><strong>Note:</strong> in order to obtain accurate search results, the location name is appended to the keyword automatically<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code><br><strong>Note:</strong> in order to obtain accurate search results, the <code>location_name</code> you specify will be automatically appended to the keyword",
+ "type": "string"
+ },
+ "max_price": {
+ "description": "<em>maximum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>600</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "min_price": {
+ "description": "<em>minimum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>100</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "min_rating": {
+ "description": "<em>minimum rating</em><br>optional field<br>you can use this field to specify guest rating higher than a certain value<br>example:<br><code>2.5</code>",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "search_this_area": {
+ "description": "<em>show hotels from the displayed area</em><br>optional field<br>can take the values: <code>true</code>, <code>false</code><br>default value: <code>true</code><br>if set to <code>false</code> the <code>search_this_area</code> mode will be turned off<br><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, the <code>location_name</code> won't be appended to the <code>keyword</code> during search<br>learn more about this parameter <a href=\"https://dataforseo.com/help-center/how-to-use-search_this_area-parameter-in-google-hotel-searches\" target=\"_blank\">on our Help Center</a>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>relevance</code> – sort by most relevant<br><code>lowest_price</code> – sort by the lowest price<br><code>highest_rating</code> – sort by highest rating<br><code>most_reviewed</code> – sort by most reviewed<br>default value: <code>relevance</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "stars": {
+ "description": "<em>hotel stars</em><br>optional field<br>set this field to <code>[5]</code> if you want to get the list of 5-star hotels only<br>example:<br><code>[3,4,5]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "adults": {
- "description": "*number of adults* optional field if you don’t specify this field, the default value of `2` will be applied; **note** that you can specify up to 6 persons including both adults and children example: `1`",
- "type": "integer"
- },
- "amenities": {
- "description": "*hotel amenities* optional field you can use this field to specify different hotel amenities example: ` [ \"free_parking\", \"pets_allowed\" ]` possible values: `\"air_conditioning\",\"all_inclusive_available\",\"bar\",\"free_breakfast\",\"fitness_center\",\"kid_friendly\",\"free_parking\",\"pets_allowed\",\"pool\",\"restaurant\",\"room_service\",\"spa\",\"free_wifi\",\"parking\",\"indoor_pool\",\"outdoor_pool\",\"wheelchair_accessible\",\"beach_access\"`",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "check_in": {
- "description": "*check-in date* optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"` **Note:** the value cannot precede the today’s date",
- "type": "string"
- },
- "check_out": {
- "description": "*check-out date* optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"` **Note:** the value cannot be less than or equal to `check_in`; the range between `check_in` and `check_out` values cannot exceed 30 days",
- "type": "string"
- },
- "children": {
- "description": "*number and age of children* optional field if you don’t specify this field, no children will be included in the search; age of child can be from `0` to `17`; **note** that you can specify up to 6 persons including both adults and children set the following value if you want to include one 14-year-old child: `[14]` set the following value if you want to include one 13-year-old child and one 8-year-old child: `[13,8]`",
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "currency": {
- "description": "*currency* optional field example: `\"USD\"`",
- "type": "string"
- },
- "depth": {
- "description": "parsing depth optional field number of results in Google Hotels default value: 18 organic results max value: 140 Note: your account will be billed per each 18 organic results regardless of paid listings in the response; thus, setting a depth above 18 may result in additional charges if Google Hotels return more than 18 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
- "type": "integer"
- },
- "free_cancellation": {
- "description": "*hotels with a free cancellation* optional field set this field to `true` if you want to get the list of hotels with free cancellation of reservations default value: `false`",
- "type": "boolean"
- },
- "is_vacation_rentals": {
- "description": "*search for vacation rentals* optional field set this field to `true` if you want to get the list of vacation rentals instead of hotels default value: `false`",
- "type": "boolean"
- },
- "keyword": {
- "description": "*keyword* optional field the keyword you specify is used to search for the list of hotels; if you don’t use this field, we will return the list of hotels found in a specified location; you can specify **up to 700 characters** in the `keyword` filed **all %## will be decoded (plus character ‘+’ will be decoded to a space character)** if you need to use the “%” character for your `keyword`, please specify it as “%25”; **Note:** in order to obtain accurate search results, the location name is appended to the keyword automatically learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_coordinate parameter should be specified in the \"latitude,longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement example: 53.476225,-2.243572n",
- "type": "string"
- },
- "location_name": {
- "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` **Note:** in order to obtain accurate search results, the `location_name` you specify will be automatically appended to the keyword",
- "type": "string"
- },
- "max_price": {
- "description": "*maximum price per night* optional field the currency of this value depends on the `currency` field example: `600`",
- "type": "integer"
- },
- "min_price": {
- "description": "*minimum price per night* optional field the currency of this value depends on the `currency` field example: `100`",
- "type": "integer"
- },
- "min_rating": {
- "description": "*minimum rating* optional field you can use this field to specify guest rating higher than a certain value example: `2.5`",
- "type": "number"
- },
- "sort_by": {
- "description": "*results sorting parameters* optional field you can use this field to sort the results possible types of sorting: `relevance` – sort by most relevant `lowest_price` – sort by the lowest price `highest_rating` – sort by highest rating `most_reviewed` – sort by most reviewed default value: `relevance`",
- "type": "string"
- },
- "stars": {
- "description": "*hotel stars* optional field set this field to `[5]` if you want to get the list of 5-star hotels only example: `[3,4,5]`",
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_qa_live8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "The Last Bookstore",
+ "language_code": "en",
+ "location_name": "Los Angeles,California,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "The Last Bookstore",
+ "language_code": "en",
+ "location_name": "Los Angeles,California,United States"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>100</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of results in SERP default value: `20` max value: `100` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance.",
- "type": "integer"
- },
- "keyword": {
- "description": "keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; 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:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A learn more about the cid and place_id identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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",
- "type": "string"
- },
- "location_name": {
- "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`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_reviews_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "depth": 50,
+ "keyword": "hedonism wines",
+ "language_name": "English",
+ "location_name": "London,England,United Kingdom",
+ "sort_by": "highest_rating"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "keyword"
- ]
- },
- {
- "required": [
- "cid"
- ]
- },
- {
- "required": [
- "place_id"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 50,
+ "keyword": "hedonism wines",
+ "language_name": "English",
+ "location_name": "London,England,United Kingdom",
+ "sort_by": "highest_rating"
+ }
+ ],
+ "properties": {
+ "cid": {
+ "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row<br>default value: <code>10</code><br>maximum value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "place_id": {
+ "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>newest</code> – sort by newest first<br><code>highest_rating</code> – sort by highest rating<br><code>lowest_rating</code> – sort by lowest rating<br><code>relevant</code> – sort by relevance<br>default value: <code>relevant</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "cid": {
- "description": "*unique, google-defined id of the business entity* **required field if you don’t specify `keyword` or `place_id`** example: `194604053573767737` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)",
- "type": "string"
- },
- "depth": {
- "description": "*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row default value: `10` maximum value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field if you don’t specify `cid` or `place_id`** the keyword you specify should indicate the name of the local establishment; you can specify **up to 700 characters** in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, **the charge per task will be multiplied by 5** Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "language_code": {
- "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 the https://api.dataforseo.com/v3/business_data/google/languages example: en",
- "type": "string"
- },
- "language_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `English`",
- "type": "string"
- },
- "location_code": {
- "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: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/locations` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "place_id": {
- "description": "*identifier of the business entity in Google Maps* **required field if you don’t specify `keyword` or `cid`** example: `GhIJQWDl0CIeQUARxks3icF8U8A` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "sort_by": {
- "description": "*results sorting parameters* optional field you can use this field to sort the results possible types of sorting: `newest` – sort by newest first `highest_rating` – sort by highest rating `lowest_rating` – sort by lowest rating `relevant` – sort by relevance default value: `relevant`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_listings_search_live5 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "categories": [
+ "pizza_restaurant"
+ ],
+ "description": "pizza",
+ "filters": [
+ [
+ "rating.value",
+ ">",
+ 3
+ ]
+ ],
+ "is_claimed": true,
+ "limit": 3,
+ "location_coordinate": "53.476225,-2.243572,10",
+ "order_by": [
+ "rating.value,desc"
+ ],
+ "title": "pizza"
+ }
+]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "categories": [
+ "pizza_restaurant"
+ ],
+ "description": "pizza",
+ "filters": [
+ [
+ "rating.value",
+ ">",
+ 3
+ ]
+ ],
+ "is_claimed": true,
+ "limit": 3,
+ "location_coordinate": "53.476225,-2.243572,10",
+ "order_by": [
+ "rating.value,desc"
+ ],
+ "title": "pizza"
+ }
+ ],
+ "properties": {
+ "categories": {
+ "description": "<em>business categories</em><br>optional field<br>the categories you specify are used to search for business listings;<br>if you don't use this field, we will return business listings found in the specified location;<br>you can specify <strong>up to 10 categories</strong>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "description": {
+ "description": "<em>description of the element in SERP</em><br>optional field<br>the description of the business entity for which the results are collected;<br>can contain up to 200 characters",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "filters": {
+ "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><br>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/business_listings/available_filters</code><br>The full list of possible filters is available <a href=\"/v3/business_data/business_listings/filters\" rel=\"noopener noreferrer\" target=\"_blank\">here.</a>n",
+ "items": {
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "is_claimed": {
+ "description": "<em>indicates whether the business is verified by its owner on Google Maps</em><br>optional field",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "limit": {
+ "description": "<em>the maximum number of returned businesses</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br>optional field<br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the value of <em>\"radius\"</em> is specified in kilometres (km)<br>the minimum value for <em>\"radius\"</em>: <code>1</code><br>the maximum value for <em>\"radius\"</em>: <code>100000</code><br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code><br>learn more about how to set location parameters in this API on our <a href=\"https://dataforseo.com/help-center/how-to-specify-location-settings-in-business-listings-api\" target=\"_blank\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "offset": {
+ "description": "<em>offset in the results array of returned businesses</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "offset_token": {
+ "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "order_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"rating.value,desc\"]</code><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"rating.value,desc\",\"rating.votes_count,desc\"]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "title": {
+ "description": "<em>title of the element in SERP</em><br>optional field<br>the name of the business entity for which the results are collected;<br>can contain up to 200 characters",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "categories": {
- "description": "*business categories* optional field the categories you specify are used to search for business listings; if you don’t use this field, we will return business listings found in the specified location; you can specify **up to 10 categories**",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "description": {
- "description": "*description of the element in SERP* optional field the description of the business entity for which the results are collected; can contain up to 200 characters",
- "type": "string"
- },
- "filters": {
- "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters The full list of possible filters is available here. n",
- "items": {},
- "type": "array"
- },
- "is_claimed": {
- "description": "*indicates whether the business is verified by its owner on Google Maps* optional field",
- "type": "boolean"
- },
- "limit": {
- "description": "*the maximum number of returned businesses* optional field default value: `100` maximum value: `1000`",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location optional field location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the value of \"radius\" is specified in kilometres (km) the minimum value for \"radius\": 1 the maximum value for \"radius\": 100000 example: 53.476225,-2.243572,200 learn more about how to set location parameters in this API on our Help Center",
- "type": "string"
- },
- "offset": {
- "description": "offset in the results array of returned businesses optional field default value: 0 if 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 Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead",
- "type": "integer"
- },
- "offset_token": {
- "description": "token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center",
- "type": "string"
- },
- "order_by": {
- "description": "*results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` – results will be sorted in the ascending order `desc` – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: `[\"rating.value,desc\"]`**note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `[\"rating.value,desc\",\"rating.votes_count,desc\"]`",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "tag": {
- "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",
- "type": "string"
- },
- "title": {
- "description": "*title of the element in SERP* optional field the name of the business entity for which the results are collected; can contain up to 200 characters",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_tripadvisor_reviews_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "location_code": 1003854,
+ "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
+ "tag": "some_string_123",
+ "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "url_path"
- ]
- },
- {
- "required": [
- "keyword"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "url_path"
- ]
- },
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "location_code": 1003854,
+ "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
+ "tag": "some_string_123",
+ "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP;<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;<br>default value: <code>10</code>;<br>max value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you do not specify <code>url_path</code></strong><br>the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<em><br></em><code class=\"long-string\">en</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<br><code class=\"long-string\">English</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "months": {
+ "description": "<em>filter by months when a traveler made a visit</em><br>optional field<br>possible values: <code>january</code>, <code>february</code>, <code>march</code>, <code>april</code>, <code>may</code>, <code>april</code>, <code>june</code>, <code>july</code>, <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code>, <code>december</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "ratings": {
+ "description": "<em>Tripadvisor traveler rating for a place of interest</em><br>optional field<br>rating based on the written reviews by a traveler after they visited a place.<br>possible values: <code>excellent</code>, <code>very_good</code>, <code>average</code>, <code>poor</code>, <code>terrible</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code><br><code>detailed_reviews</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "translate_reviews": {
+ "description": "<em>translate reviews according to the URL path</em><br>optional field<br>if set to <code>true</code>, returned reviews will be translated to the language matching the specified <code>url_path</code>;<br>for example, if <code>url_path</code> contains <code>tripadvisor.it</code> and <code>translate_reviews</code> is <code>true</code>, reviews will be translated to the Italian language;<br>default value: <code>true</code><br>you can learn more about how reviews are translated in <a href=\"https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api\" rel=\"noopener noreferrer\" target=\"_blank\">this Help Center article</a>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "url_path": {
+ "description": "<em>URL path of the business entity</em><br><strong>required field if you do not specify <code>keyword</code></strong><br>URL path to the Tripadvisor page of the business entity;<br>examples:<br><code>Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code><br><code>https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code>",
+ "type": "string"
+ },
+ "visit_type": {
+ "description": "<em>filter by type of travelers who left a review</em><br>optional field<br>possible values: <code>families</code>, <code>couples</code>, <code>solo</code>, <code>business</code>, <code>friends</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row; default value: `10`; max value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field if you do not specify `url_path`** the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor; you can specify up to 700 characters in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your `keyword`, please specify it as “%25”",
- "type": "string"
- },
- "language_code": {
- "description": "*search engine language code* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `en` You will be additionally charged for setting a language parameter in this endpoint.",
- "type": "string"
- },
- "language_name": {
- "description": "*full name of search engine language* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `English` You will be additionally charged for setting a language parameter in this endpoint.",
- "type": "string"
- },
- "location_code": {
- "description": "*search engine location code* **required field if you don’t specify `location_name` or `url_path`** 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/tripadvisor/locations` example: `1003854`",
- "type": "integer"
- },
- "location_name": {
- "description": "*full name of search engine location* **required field if you don’t specify `location_code` or `url_path`** you 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` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "months": {
- "description": "*filter by months when a traveler made a visit* optional field possible values: `january`, `february`, `march`, `april`, `may`, `april`, `june`, `july`, `august`, `september`, `october`, `november`, `december` you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "ratings": {
- "description": "*Tripadvisor traveler rating for a place of interest* optional field rating based on the written reviews by a traveler after they visited a place. possible values: `excellent`, `very_good`, `average`, `poor`, `terrible` you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "search_reviews_keyword": {
- "description": "*search reviews containing a specified keyword* example: `dessert`",
- "type": "string"
- },
- "sort_by": {
- "description": "*results sorting parameters* optional field you can use this field to sort the results; possible types of sorting: `most_recent` `detailed_reviews`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- },
- "translate_reviews": {
- "description": "*translate reviews according to the URL path* optional field if set to `true`, returned reviews will be translated to the language matching the specified `url_path`; for example, if `url_path` contains `tripadvisor.it` and `translate_reviews` is `true`, reviews will be translated to the Italian language; default value: `true` you can learn more about how reviews are translated in [this Help Center article](https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api)",
- "type": "boolean"
- },
- "url_path": {
- "description": "*URL path of the business entity* **required field if you do not specify `keyword`** URL path to the Tripadvisor page of the business entity; examples: `Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html` `https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html`",
- "type": "string"
- },
- "visit_type": {
- "description": "*filter by type of travelers who left a review* optional field possible values: `families`, `couples`, `solo`, `business`, `friends` you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_tripadvisor_search_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "depth": 30,
+ "keyword": "pizza",
+ "location_code": 1003854
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 30,
+ "keyword": "pizza",
+ "location_code": 1003854
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>210</code><p><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category, company name, or a prominent place;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row; default value: `30`; maximum value: `210` **Your account will be billed per each SERP containing up to 30 results;** Setting depth above 30 may result in additional charges if the search engine returns more than 30 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field** the keyword you specify should indicate a business category, company name, or a prominent place; you can specify up to 700 characters in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your `keyword`, please specify it as “%25” learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "location_code": {
- "description": "*search engine location code* **required field if you don’t specify `location_name`** 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/tripadvisor/locations` example: `1003854`",
- "type": "integer"
- },
- "location_name": {
- "description": "*full name of search engine location* **required field if you don’t specify `location_code`** you 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` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_trustpilot_reviews_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "depth": 40,
+ "domain": "www.thepearlsource.com"
+ }
+]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 40,
+ "domain": "www.thepearlsource.com"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "domain": {
+ "description": "<em>domain of the local establishment</em><br><strong>required field</strong><br>domain of the local establishment on Trustpilot;<br>you can find the domain in the URL of every business listed on Trustpilot<br>example:<br><code>www.thepearlsource.com</code><br><code>https://www.trustpilot.com/review/<strong>www.thepearlsource.com</strong></code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameter</em><br>optional field<br>you can use this field to sort the results;<br>possible sorting parameters:<br><code>recency</code> — most recent reviews first;<br><code>relevance</code> — most relevant reviews first;<br>default value: <code>relevance</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of reviews to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row default value: `20` maximum value: `200` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results.",
- "type": "integer"
- },
- "domain": {
- "description": "*domain of the local establishment* **required field** domain of the local establishment on Trustpilot; you can find the domain in the URL of every business listed on Trustpilot example: `www.thepearlsource.com` `https://www.trustpilot.com/review/www.thepearlsource.com`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "sort_by": {
- "description": "*results sorting parameter* optional field you can use this field to sort the results; possible sorting parameters: `recency` — most recent reviews first; `relevance` — most relevant reviews first; default value: `relevance`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "domain"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_trustpilot_search_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "depth": 20,
+ "keyword": "pizza restaurant"
+ }
+]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 20,
+ "keyword": "pizza restaurant"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;<br>default value: <code>10</code>;<br>maximum value: <code>140</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category or company name;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row; default value: `10`; maximum value: `140` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field** the keyword you specify should indicate a business category or company name; you can specify up to 700 characters in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your `keyword`, please specify it as “%25” learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truesearch17 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / category / anyOfRemoved value: -[
- {
- "enum": [
- "seo",
- "finance",
- "social",
- "search",
- "sales",
- "mail"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
-]Input schema / properties / category / defaultRemoved value: -nullInput schema / properties / category / descriptionPrevious value: -"Restrict to one category (seo, finance, social, search, sales, mail). Omit to search everything."New value: +"Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.)"Input schema / properties / category / enumAdded value: +[
+ "seo",
+ "finance",
+ "social",
+ "search",
+ "sales",
+ "mail"
+]Input schema / properties / category / typeAdded value: +"string"Input schema / properties / known_fieldsAdded value: +{
+ "additionalProperties": true,
+ "default": {},
+ "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.",
+ "type": "object"
+}Input schema / properties / limit / descriptionPrevious value: -"Maximum candidates, 1-10"New value: +"Maximum number of additional direct tool candidates."Input schema / properties / limit / maximumAdded value: +20Input schema / properties / limit / minimumAdded value: +1Input schema / properties / provider_filtersAdded value: +{
+ "default": [],
+ "description": "Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 50,
+ "type": "array",
+ "uniqueItems": true
+}Input schema / properties / query / descriptionPrevious value: -"What you need, in plain language, e.g. 'backlinks of a domain', 'recent tweets by a user', 'insider trades for AAPL'. English works best."New value: +"Natural-language capability or task to discover."Input schema / properties / query / maxLengthAdded value: +2000Input schema / properties / query / minLengthAdded value: +1Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Output schema / propertiesAdded value: +{
+ "next_steps_guidance": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "plan": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "canonical_use_case": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "known_pitfalls": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "plan_ref": {
+ "type": "string"
+ },
+ "primary_tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "recommended_steps": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "related_tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "canonical_use_case",
+ "description",
+ "known_pitfalls",
+ "plan_ref",
+ "primary_tools",
+ "recommended_steps",
+ "related_tools"
+ ]
+ },
+ "retrieval_mode": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "search_id": {
+ "type": "string"
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]{1,128}$",
+ "type": "string"
+ },
+ "tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "arguments_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "execution_supported": {
+ "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
+ "type": "boolean"
+ },
+ "execution_unsupported_reason": {
+ "description": "Why execution and quoting remain unavailable through this router.",
+ "type": "string"
+ },
+ "has_full_schema": {
+ "type": "boolean"
+ },
+ "match_reasons": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "price": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "retrieval_debug": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "fused_rank": {
+ "type": "integer"
+ },
+ "fused_score": {
+ "type": "number"
+ },
+ "lexical_rank": {
+ "type": "integer"
+ },
+ "lexical_score": {
+ "type": "number"
+ },
+ "rerank_admission_rank": {
+ "type": "integer"
+ },
+ "rerank_rank": {
+ "type": "integer"
+ },
+ "rerank_score": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "runtime_availability": {
+ "type": "string"
+ },
+ "vector_view_ranks": {
+ "additionalProperties": {
+ "type": "integer"
+ },
+ "type": "object"
+ },
+ "vector_view_scores": {
+ "additionalProperties": {
+ "type": "number"
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "fused_rank",
+ "fused_score",
+ "lexical_rank",
+ "lexical_score",
+ "rerank_admission_rank",
+ "rerank_rank",
+ "runtime_availability",
+ "vector_view_ranks",
+ "vector_view_scores"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "tool": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "description",
+ "has_full_schema",
+ "price",
+ "summary",
+ "tool"
+ ],
+ "type": "object"
+ }
+ }
+}Output schema / requiredAdded value: +[
+ "next_steps_guidance",
+ "search_id",
+ "session_id",
+ "tools"
+]use1 field changedInput schema / properties / max_price_usd / descriptionPrevious value: -"Refuse the call before any spend if it would cost more than this many USD"New value: +"Refuse the call before any spend if its quoted price is above this many USD"batch_get_schemabatch_quotebatch_use18 fields changedInput schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / descriptionAdded value: +"Up to 20 items of {call_id, operation_id, arguments}; steps at the same execution_level of a plan go in one batch"Input schema / properties / calls / items / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / items / additionalPropertiesPrevious value: -falseNew value: +trueInput schema / properties / calls / items / propertiesRemoved value: -{
- "arguments": {
- "additionalProperties": true,
- "description": "Strictly schema-compliant arguments using the exact field names and types from this tool's arguments_schema.",
- "type": "object"
- },
- "call_id": {
- "description": "Caller-chosen identifier unique within this batch.",
- "maxLength": 128,
- "minLength": 1,
- "type": "string"
- },
- "tool": {
- "description": "Exact tool name returned by search or batch_get_schema. Never invent a name.",
- "minLength": 1,
- "type": "string"
- }
-}Input schema / properties / calls / items / requiredRemoved value: -[
- "call_id",
- "tool",
- "arguments"
-]Input schema / properties / calls / maxItemsRemoved value: -20Input schema / properties / calls / minItemsRemoved value: -1Input schema / properties / max_price_usdAdded value: +{
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Per-call price cap applied to every item"
+}Input schema / properties / search_id / anyOfAdded value: +[
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+]Input schema / properties / search_id / defaultAdded value: +nullInput schema / properties / search_id / descriptionPrevious value: -"Optional search correlation identifier returned by search."New value: +"search_id from the search that found these operations"Input schema / properties / search_id / typeRemoved value: -"string"Input schema / properties / session_idRemoved value: -{
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "pattern": "^[A-Za-z0-9_-]*$",
- "type": "string"
-}Output schema / $defsRemoved value: -{
- "jsonValue": {
- "anyOf": [
- {
- "additionalProperties": {
- "$ref": "#/$defs/jsonValue"
- },
- "type": "object"
- },
- {
- "items": {
- "$ref": "#/$defs/jsonValue"
- },
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "description": "JSON value returned by the upstream tool."
- }
-}Output schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Output schema / propertiesRemoved value: -{
- "batch_id": {
- "type": "string"
- },
- "error_count": {
- "minimum": 0,
- "type": "integer"
- },
- "next_steps_guidance": {
- "description": "Deterministic next-step instructions derived from this result. Not an authorization grant.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "results": {
- "items": {
- "$schema": "https://json-schema.org/draft/2020-12/schema",
- "additionalProperties": false,
- "properties": {
- "call_id": {
- "type": "string"
- },
- "customer_cost_micros_usd": {
- "description": "Actual customer charge settled by AIsaServices, in micro-USD. Omitted when the upstream response does not report it.",
- "minimum": 0,
- "type": "integer"
- },
- "data": {
- "$ref": "#/$defs/jsonValue"
- },
- "error": {
- "anyOf": [
- {
- "$schema": "https://json-schema.org/draft/2020-12/schema",
- "additionalProperties": false,
- "properties": {
- "message": {
- "type": "string"
- },
- "retryable": {
- "type": "boolean"
- },
- "status": {
- "type": "integer"
- },
- "type": {
- "enum": [
- "validation",
- "authentication",
- "payment",
- "permission",
- "rate_limit",
- "upstream",
- "timeout",
- "internal"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "status",
- "retryable"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "request_id": {
- "type": "string"
- },
- "successful": {
- "type": "boolean"
- },
- "tool": {
- "type": "string"
- },
- "upstream_status": {
- "description": "HTTP status returned by AIsaServices when a request was dispatched.",
- "type": "integer"
- }
- },
- "required": [
- "call_id",
- "tool",
- "successful",
- "request_id"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "session_id": {
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "minLength": 1,
- "pattern": "^[A-Za-z0-9_-]*$",
- "type": "string"
- },
- "success_count": {
- "minimum": 0,
- "type": "integer"
- },
- "total_count": {
- "minimum": 1,
- "type": "integer"
- }
-}Output schema / requiredRemoved value: -[
- "session_id",
- "batch_id",
- "total_count",
- "success_count",
- "error_count",
- "results",
- "next_steps_guidance"
-]get_dataforseo_business_google_extended_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_business_google_gmb_updates_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_business_google_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_business_tripadvisor_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_business_tripadvisor_search_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_business_trustpilot_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_business_trustpilot_search_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_details13 fields changedInput schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Input schema / properties / argumentsAdded value: +{
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "The arguments the operation would be called with, for a price that reflects them. Keyed by operation_id for a batch, or passed flat for a single operation_id. Routes whose required parameters are validated before pricing have no price without them."
+}Input schema / properties / include_arguments_schemaRemoved value: -{
- "default": true,
- "description": "Return the complete arguments_schema. Defaults to true.",
- "type": "boolean"
-}Input schema / properties / include_documentation / descriptionPrevious value: -"Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support."New value: +"Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged."Input schema / properties / include_response_schemaRemoved value: -{
- "default": false,
- "description": "Return the complete response_schema. Defaults to false.",
- "type": "boolean"
-}Input schema / properties / operation_idAdded value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "One operation_id from search"
+}Input schema / properties / operation_idsAdded value: +{
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Up to 20 operation_ids, for a batch"
+}Input schema / properties / session_idRemoved value: -{
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "pattern": "^[A-Za-z0-9_-]*$",
- "type": "string"
-}Input schema / properties / toolsRemoved value: -{
- "description": "Exact tool names returned by search whose complete contracts are needed. Never invent tool names.",
- "items": {
- "minLength": 1,
- "pattern": "^\\S(?:.*\\S)?$",
- "type": "string"
- },
- "maxItems": 20,
- "minItems": 1,
- "type": "array",
- "uniqueItems": true
-}Input schema / properties / with_quoteAdded value: +{
+ "default": true,
+ "description": "Whether each operation is priced for this account before the answer. One round trip per operation; spends nothing.",
+ "type": "boolean"
+}Input schema / requiredRemoved value: -[
- "tools"
-]Output schema / propertiesRemoved value: -{
- "error_count": {
- "type": "integer"
- },
- "next_steps_guidance": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "session_id": {
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "minLength": 1,
- "pattern": "^[A-Za-z0-9_-]{1,128}$",
- "type": "string"
- },
- "success_count": {
- "type": "integer"
- },
- "tools": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "arguments_schema": {
- "additionalProperties": true,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ]
- },
- "canonical_operation_id": {
- "type": "string"
- },
- "documentation": {
- "additionalProperties": true,
- "type": "object"
- },
- "error": {
- "additionalProperties": false,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ],
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- },
- "required": [
- "code",
- "message"
- ]
- },
- "execution_supported": {
- "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
- "type": "boolean"
- },
- "execution_unsupported_reason": {
- "description": "Why execution and quoting remain unavailable through this router.",
- "type": "string"
- },
- "idempotent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "boolean"
- }
- ]
- },
- "known_pitfalls": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "read_only": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "boolean"
- }
- ]
- },
- "response_schema": {
- "additionalProperties": true,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ]
- },
- "side_effects": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "successful": {
- "type": "boolean"
- }
- },
- "required": [
- "successful"
- ],
- "type": "object"
- },
- "type": "object"
- },
- "total_count": {
- "type": "integer"
- }
-}Output schema / requiredRemoved value: -[
- "error_count",
- "next_steps_guidance",
- "session_id",
- "success_count",
- "tools",
- "total_count"
-]post_dataforseo_business_google_extended_reviews_submit7 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "cid": "17626775537598922320",
- "language_name": "english",
- "location_name": "London,England,United Kingdom"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "keyword"
+ ]
+ },
+ {
+ "required": [
+ "cid"
+ ]
+ },
+ {
+ "required": [
+ "place_id"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "cid": "17626775537598922320",
- "language_name": "english",
- "location_name": "London,England,United Kingdom"
- }
- ],
- "properties": {
- "cid": {
- "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
- "type": "string"
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>1000</code><p><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>three times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "place_id": {
- "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "cid": {
+ "description": "*unique, google-defined id of the business entity* **required field if you don’t specify `keyword` or `place_id`** example: `194604053573767737` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the Google Reviews API",
+ "type": "string"
+ },
+ "depth": {
+ "description": "*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row default value: `20` maximum value: `1000` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results.",
+ "type": "integer"
+ },
+ "keyword": {
+ "description": "*keyword* **required field if you don’t specify `cid` or `place_id`** the keyword you specify should indicate the name of the local establishment; you can specify **up to 700 characters** in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, **the charge per task will be multiplied by 5** Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) **Note:** if you use this field, your account will be charged **three times the standard rate** for tasks involving the Google Reviews API",
+ "type": "string"
+ },
+ "language_code": {
+ "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 the https://api.dataforseo.com/v3/business_data/google/languages example: enn",
+ "type": "string"
+ },
+ "language_name": {
+ "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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `English`",
+ "type": "string"
+ },
+ "location_code": {
+ "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",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "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_code location_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 example: 53.476225,-2.243572,200n",
+ "type": "string"
+ },
+ "location_name": {
+ "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 the `https://api.dataforseo.com/v3/business_data/google/locations` example: `London,England,United Kingdom`",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "place_id": {
+ "description": "*identifier of the business entity in Google Maps* **required field if you don’t specify `keyword` or `cid`** example: `GhIJQWDl0CIeQUARxks3icF8U8A` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the Google Reviews API",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "priority": {
+ "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_google_gmb_info_live8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "keyword": "RustyBrick, Inc.",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "RustyBrick, Inc.",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "keyword": {
+ "description": "keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; 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:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A learn more about the cid and place_id identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
+ "type": "string"
+ },
+ "language_code": {
+ "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",
+ "type": "string"
+ },
+ "language_name": {
+ "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`",
+ "type": "string"
+ },
+ "location_code": {
+ "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",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "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_code location_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",
+ "type": "string"
+ },
+ "location_name": {
+ "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`",
+ "type": "string"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "keyword"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_google_gmb_updates_submit8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "keyword": "RustyBrick, Inc.",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "RustyBrick, Inc.",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of updates in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row<br><strong>please note that Google returns 4490 updates maximum</strong><br>default value: <code>10</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;this field can also be used to pass <code>cid</code> (unique, google-defined id of the business entity) or <code>place_id</code> (identifier of the business entity in Google Maps) parameters<br>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "depth": {
+ "description": "*parsing depth* optional field number of updates in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row **please note that Google returns 4490 updates maximum** default value: `10`",
+ "type": "integer"
+ },
+ "keyword": {
+ "description": "*keyword* **required field** the keyword you specify should indicate the name of the local establishment you can specify **up to 700 characters** in the `keyword` filed **all %## will be decoded (plus character ‘+’ will be decoded to a space character)** if you need to use the “%” character for your `keyword`, please specify it as “%25”;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 example: `cid:194604053573767737` `place_id:GhIJQWDl0CIeQUARxks3icF8U8A`learn more about the `cid` and `place_id` identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)",
+ "type": "string"
+ },
+ "language_code": {
+ "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 the https://api.dataforseo.com/v3/business_data/google/languages example: enn",
+ "type": "string"
+ },
+ "language_name": {
+ "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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `English`",
+ "type": "string"
+ },
+ "location_code": {
+ "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",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "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_code location_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 example: 53.476225,-2.243572,200n",
+ "type": "string"
+ },
+ "location_name": {
+ "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 the `https://api.dataforseo.com/v3/business_data/google/locations` example: `London,England,United Kingdom`",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "priority": {
+ "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "keyword"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_google_hotel_info_live8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "hotel_identifier": "CgoI-KWyzenM_MV3EAE",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "hotel_identifier": "CgoI-KWyzenM_MV3EAE",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "adults": {
- "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "check_in": {
- "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>the value must not be earlier than today's date<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "check_out": {
- "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "children": {
- "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "currency": {
- "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "hotel_identifier": {
- "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "load_prices_by_dates": {
- "description": "<em>load hotel stay prices by dates</em><br>optional field<br>if you specify this parameter with <code>true</code>, the response will include the <code>prices_by_dates</code> array with hotel stay prices divided by dates<br>if you use this parameter, you will be charged <strong>double the base price for a request</strong>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude, longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "prices_date_range": {
- "description": "<em>predefined period for retrieving daily price data</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if the <code>prices_start_date </code>is not specified, the start date is set to <code>check_in</code> date<br>possible values: <code>month</code>, <code>three_months</code>, <code>six_months</code>, <code>year</code><br>default value: <code>month</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "prices_end_date": {
- "description": "<em>end date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, you will get prices by date for the month <br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-21</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "prices_start_date": {
- "description": "<em>start date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, the start date is set to <code>check_in</code> date<br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-20</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "adults": {
+ "description": "*number of adults* optional field if you don’t specify this field, two adults will be used by default example: `1`",
+ "type": "integer"
+ },
+ "check_in": {
+ "description": "*check-in date* optional field if you don’t specify this field, tomorrow’s date will be used by default; the value must not be earlier than today’s date date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
+ "type": "string"
+ },
+ "check_out": {
+ "description": "*check-out date* optional field if you don’t specify this field, our system will apply the date of two days from now by default; **Note:** the value cannot be less than or equal to `check_in`; the range between `check_in` and `check_out` values cannot exceed 30 days date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
+ "type": "string"
+ },
+ "children": {
+ "description": "*number and age of children* optional field if you don’t specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: `[14]` set the following value if you want to include one 13-years-old child and one 8-years-old child: `[13,8]`",
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "currency": {
+ "description": "*currency* optional field example: `\"USD\"`",
+ "type": "string"
+ },
+ "hotel_identifier": {
+ "description": "*unique hotel identifier* **required field** unique identifier of a hotel entity in Google search; you can obtain the value by making a request to Advanced [Google SERP API](https://docs.dataforseo.com/v3/serp/google/organic/overview.md) (enclosed in the `hotels` element of the response), or the [Hotel Searches endpoint](https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post.md) of Business Data API example: `ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE`",
+ "type": "string"
+ },
+ "language_code": {
+ "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",
+ "type": "string"
+ },
+ "language_name": {
+ "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`",
+ "type": "string"
+ },
+ "load_prices_by_dates": {
+ "description": "*load hotel stay prices by dates* optional field if you specify this parameter with `true`, the response will include the `prices_by_dates` array with hotel stay prices divided by dates if you use this parameter, you will be charged **double the base price for a request**",
+ "type": "boolean"
+ },
+ "location_code": {
+ "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",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "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_code location_coordinate parameter should be specified in the \"latitude, longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572n",
+ "type": "string"
+ },
+ "location_name": {
+ "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`",
+ "type": "string"
+ },
+ "prices_date_range": {
+ "description": "*predefined period for retrieving daily price data* optional field to use this parameter, you must specify `load_prices_by_dates` with `true` if the `prices_start_date `is not specified, the start date is set to `check_in` date possible values: `month`, `three_months`, `six_months`, `year` default value: `month`",
+ "type": "string"
+ },
+ "prices_end_date": {
+ "description": "*end date to load prices by dates* optional field to use this parameter, you must specify `load_prices_by_dates` with `true` if this parameter is not specified, you will get prices by date for the month date format: `yyyy-mm-dd` example: `2025-05-21`",
+ "type": "string"
+ },
+ "prices_start_date": {
+ "description": "*start date to load prices by dates* optional field to use this parameter, you must specify `load_prices_by_dates` with `true` if this parameter is not specified, the start date is set to `check_in` date date format: `yyyy-mm-dd` example: `2025-05-20`",
+ "type": "string"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "hotel_identifier"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_google_hotel_info_live_html8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
- "language_code": "en",
- "location_name": "New York,New York,United States"
- }
- ],
- "properties": {
- "adults": {
- "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "check_in": {
- "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "check_out": {
- "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "children": {
- "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "currency": {
- "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "hotel_identifier": {
- "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post/\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-hotels-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "adults": {
+ "description": "*number of adults* optional field if you don’t specify this field, two adults will be used by default example: `1`",
+ "type": "integer"
+ },
+ "check_in": {
+ "description": "*check-in date* optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
+ "type": "string"
+ },
+ "check_out": {
+ "description": "*check-out date* optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
+ "type": "string"
+ },
+ "children": {
+ "description": "*number and age of children* optional field if you don’t specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: `[14]` set the following value if you want to include one 13-years-old child and one 8-years-old child: `[13,8]`",
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "currency": {
+ "description": "*currency* optional field example: `\"USD\"`",
+ "type": "string"
+ },
+ "hotel_identifier": {
+ "description": "*unique hotel identifier* **required field** unique identifier of a hotel entity in Google search; you can obtain the value by making a request to Advanced [Google SERP API](https://docs.dataforseo.com/v3/serp/google/organic/overview.md) (enclosed in the `hotels` element of the response), or the [Hotel Searches endpoint](https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post.md) of Business Data API example: `ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE`",
+ "type": "string"
+ },
+ "language_code": {
+ "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",
+ "type": "string"
+ },
+ "language_name": {
+ "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`",
+ "type": "string"
+ },
+ "location_code": {
+ "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",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "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_code location_coordinate parameter should be specified in the \"latitude,longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572n",
+ "type": "string"
+ },
+ "location_name": {
+ "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`",
+ "type": "string"
+ },
+ "priority": {
+ "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "tag": {
+ "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` array of the response",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "hotel_identifier"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_google_hotel_searches_live7 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "adults": 2,
- "check_in": "2023-06-01",
- "check_out": "2023-06-30",
- "children": [
- "14"
- ],
- "currency": "USD",
- "keyword": "cheap hotel",
- "language_code": "en",
- "location_name": "New York,New York,United States",
- "priority": 2,
- "sort_by": "highest_rating",
- "tag": "example"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "adults": 2,
- "check_in": "2023-06-01",
- "check_out": "2023-06-30",
- "children": [
- "14"
- ],
- "currency": "USD",
- "keyword": "cheap hotel",
- "language_code": "en",
- "location_name": "New York,New York,United States",
- "priority": 2,
- "sort_by": "highest_rating",
- "tag": "example"
- }
- ],
- "properties": {
- "adults": {
- "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, the default value of <code>2</code> will be applied;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>example:<br><code>1</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "amenities": {
- "description": "<em>hotel amenities</em><br>optional field<br>you can use this field to specify different hotel amenities<br>example:<br><code> [<br> \"free_parking\",<br> \"pets_allowed\"<br> ]<br></code><br>possible values:<br>`\"air_conditioning\",<br>\"all_inclusive_available\",<br>\"bar\",<br>\"free_breakfast\",<br>\"fitness_center\",<br>\"kid_friendly\",<br>\"free_parking\",<br>\"pets_allowed\",<br>\"pool\",<br>\"restaurant\",<br>\"room_service\",<br>\"spa\",<br>\"free_wifi\",<br>\"parking\",<br>\"indoor_pool\",<br>\"outdoor_pool\",<br>\"wheelchair_accessible\",<br>\"beach_access\"`",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "check_in": {
- "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot precede the today's date",
- "type": [
- "string",
- "null"
- ]
- },
- "check_out": {
- "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days",
- "type": [
- "string",
- "null"
- ]
- },
- "children": {
- "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<br>age of child can be from <code>0</code> to <code>17</code>;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>set the following value if you want to include one 14-year-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-year-old child and one 8-year-old child:<br><code>[13,8]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "currency": {
- "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results in Google Hotels<br>default value: <code>18</code> organic results<br>max value: <code>140</code><br><strong>Note:</strong> your account will be billed per each 18 organic results regardless of paid listings in the response;<br>thus, setting a depth above <code>18</code> may result in additional charges if Google Hotels return more than 18 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
- "type": [
- "integer",
- "null"
- ]
- },
- "free_cancellation": {
- "description": "<em>hotels with a free cancellation</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of hotels with free cancellation of reservations<br>default value: <code>false</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "is_vacation_rentals": {
- "description": "<em>search for vacation rentals</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of vacation rentals instead of hotels<br>default value: <code>false</code>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br>optional field<br>the keyword you specify is used to search for the list of hotels;<br>if you don't use this field, we will return the list of hotels found in a specified location;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <br><strong>Note:</strong> in order to obtain accurate search results, the location name is appended to the keyword automatically<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code><br><strong>Note:</strong> in order to obtain accurate search results, the <code>location_name</code> you specify will be automatically appended to the keyword",
- "type": "string"
- },
- "max_price": {
- "description": "<em>maximum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>600</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "min_price": {
- "description": "<em>minimum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>100</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "min_rating": {
- "description": "<em>minimum rating</em><br>optional field<br>you can use this field to specify guest rating higher than a certain value<br>example:<br><code>2.5</code>",
- "type": [
- "number",
- "null"
- ]
- },
- "search_this_area": {
- "description": "<em>show hotels from the displayed area</em><br>optional field<br>can take the values: <code>true</code>, <code>false</code><br>default value: <code>true</code><br>if set to <code>false</code> the <code>search_this_area</code> mode will be turned off<br><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, the <code>location_name</code> won't be appended to the <code>keyword</code> during search<br>learn more about this parameter <a href=\"https://dataforseo.com/help-center/how-to-use-search_this_area-parameter-in-google-hotel-searches\" target=\"_blank\">on our Help Center</a>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>relevance</code> – sort by most relevant<br><code>lowest_price</code> – sort by the lowest price<br><code>highest_rating</code> – sort by highest rating<br><code>most_reviewed</code> – sort by most reviewed<br>default value: <code>relevance</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "stars": {
- "description": "<em>hotel stars</em><br>optional field<br>set this field to <code>[5]</code> if you want to get the list of 5-star hotels only<br>example:<br><code>[3,4,5]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "adults": {
+ "description": "*number of adults* optional field if you don’t specify this field, the default value of `2` will be applied; **note** that you can specify up to 6 persons including both adults and children example: `1`",
+ "type": "integer"
+ },
+ "amenities": {
+ "description": "*hotel amenities* optional field you can use this field to specify different hotel amenities example: ` [ \"free_parking\", \"pets_allowed\" ]` possible values: `\"air_conditioning\",\"all_inclusive_available\",\"bar\",\"free_breakfast\",\"fitness_center\",\"kid_friendly\",\"free_parking\",\"pets_allowed\",\"pool\",\"restaurant\",\"room_service\",\"spa\",\"free_wifi\",\"parking\",\"indoor_pool\",\"outdoor_pool\",\"wheelchair_accessible\",\"beach_access\"`",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "check_in": {
+ "description": "*check-in date* optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"` **Note:** the value cannot precede the today’s date",
+ "type": "string"
+ },
+ "check_out": {
+ "description": "*check-out date* optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"` **Note:** the value cannot be less than or equal to `check_in`; the range between `check_in` and `check_out` values cannot exceed 30 days",
+ "type": "string"
+ },
+ "children": {
+ "description": "*number and age of children* optional field if you don’t specify this field, no children will be included in the search; age of child can be from `0` to `17`; **note** that you can specify up to 6 persons including both adults and children set the following value if you want to include one 14-year-old child: `[14]` set the following value if you want to include one 13-year-old child and one 8-year-old child: `[13,8]`",
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "currency": {
+ "description": "*currency* optional field example: `\"USD\"`",
+ "type": "string"
+ },
+ "depth": {
+ "description": "parsing depth optional field number of results in Google Hotels default value: 18 organic results max value: 140 Note: your account will be billed per each 18 organic results regardless of paid listings in the response; thus, setting a depth above 18 may result in additional charges if Google Hotels return more than 18 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
+ "type": "integer"
+ },
+ "free_cancellation": {
+ "description": "*hotels with a free cancellation* optional field set this field to `true` if you want to get the list of hotels with free cancellation of reservations default value: `false`",
+ "type": "boolean"
+ },
+ "is_vacation_rentals": {
+ "description": "*search for vacation rentals* optional field set this field to `true` if you want to get the list of vacation rentals instead of hotels default value: `false`",
+ "type": "boolean"
+ },
+ "keyword": {
+ "description": "*keyword* optional field the keyword you specify is used to search for the list of hotels; if you don’t use this field, we will return the list of hotels found in a specified location; you can specify **up to 700 characters** in the `keyword` filed **all %## will be decoded (plus character ‘+’ will be decoded to a space character)** if you need to use the “%” character for your `keyword`, please specify it as “%25”; **Note:** in order to obtain accurate search results, the location name is appended to the keyword automatically learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
+ "type": "string"
+ },
+ "language_code": {
+ "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",
+ "type": "string"
+ },
+ "language_name": {
+ "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`",
+ "type": "string"
+ },
+ "location_code": {
+ "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",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "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_code location_coordinate parameter should be specified in the \"latitude,longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement example: 53.476225,-2.243572n",
+ "type": "string"
+ },
+ "location_name": {
+ "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` **Note:** in order to obtain accurate search results, the `location_name` you specify will be automatically appended to the keyword",
+ "type": "string"
+ },
+ "max_price": {
+ "description": "*maximum price per night* optional field the currency of this value depends on the `currency` field example: `600`",
+ "type": "integer"
+ },
+ "min_price": {
+ "description": "*minimum price per night* optional field the currency of this value depends on the `currency` field example: `100`",
+ "type": "integer"
+ },
+ "min_rating": {
+ "description": "*minimum rating* optional field you can use this field to specify guest rating higher than a certain value example: `2.5`",
+ "type": "number"
+ },
+ "sort_by": {
+ "description": "*results sorting parameters* optional field you can use this field to sort the results possible types of sorting: `relevance` – sort by most relevant `lowest_price` – sort by the lowest price `highest_rating` – sort by highest rating `most_reviewed` – sort by most reviewed default value: `relevance`",
+ "type": "string"
+ },
+ "stars": {
+ "description": "*hotel stars* optional field set this field to `[5]` if you want to get the list of 5-star hotels only example: `[3,4,5]`",
+ "items": {
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_google_qa_live8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "keyword": "The Last Bookstore",
- "language_code": "en",
- "location_name": "Los Angeles,California,United States"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "The Last Bookstore",
- "language_code": "en",
- "location_name": "Los Angeles,California,United States"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>100</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "depth": {
+ "description": "*parsing depth* optional field number of results in SERP default value: `20` max value: `100` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance.",
+ "type": "integer"
+ },
+ "keyword": {
+ "description": "keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; 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:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A learn more about the cid and place_id identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
+ "type": "string"
+ },
+ "language_code": {
+ "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",
+ "type": "string"
+ },
+ "language_name": {
+ "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`",
+ "type": "string"
+ },
+ "location_code": {
+ "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",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "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_code location_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",
+ "type": "string"
+ },
+ "location_name": {
+ "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`",
+ "type": "string"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "keyword"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_google_reviews_submit7 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "depth": 50,
- "keyword": "hedonism wines",
- "language_name": "English",
- "location_name": "London,England,United Kingdom",
- "sort_by": "highest_rating"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "keyword"
+ ]
+ },
+ {
+ "required": [
+ "cid"
+ ]
+ },
+ {
+ "required": [
+ "place_id"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "depth": 50,
- "keyword": "hedonism wines",
- "language_name": "English",
- "location_name": "London,England,United Kingdom",
- "sort_by": "highest_rating"
- }
- ],
- "properties": {
- "cid": {
- "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
- "type": "string"
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row<br>default value: <code>10</code><br>maximum value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "place_id": {
- "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>newest</code> – sort by newest first<br><code>highest_rating</code> – sort by highest rating<br><code>lowest_rating</code> – sort by lowest rating<br><code>relevant</code> – sort by relevance<br>default value: <code>relevant</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "cid": {
+ "description": "*unique, google-defined id of the business entity* **required field if you don’t specify `keyword` or `place_id`** example: `194604053573767737` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)",
+ "type": "string"
+ },
+ "depth": {
+ "description": "*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row default value: `10` maximum value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.",
+ "type": "integer"
+ },
+ "keyword": {
+ "description": "*keyword* **required field if you don’t specify `cid` or `place_id`** the keyword you specify should indicate the name of the local establishment; you can specify **up to 700 characters** in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, **the charge per task will be multiplied by 5** Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
+ "type": "string"
+ },
+ "language_code": {
+ "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 the https://api.dataforseo.com/v3/business_data/google/languages example: en",
+ "type": "string"
+ },
+ "language_name": {
+ "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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `English`",
+ "type": "string"
+ },
+ "location_code": {
+ "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: 2840",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "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_code location_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 example: 53.476225,-2.243572,200",
+ "type": "string"
+ },
+ "location_name": {
+ "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 the `https://api.dataforseo.com/v3/business_data/google/locations` example: `London,England,United Kingdom`",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "place_id": {
+ "description": "*identifier of the business entity in Google Maps* **required field if you don’t specify `keyword` or `cid`** example: `GhIJQWDl0CIeQUARxks3icF8U8A` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "priority": {
+ "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "sort_by": {
+ "description": "*results sorting parameters* optional field you can use this field to sort the results possible types of sorting: `newest` – sort by newest first `highest_rating` – sort by highest rating `lowest_rating` – sort by lowest rating `relevant` – sort by relevance default value: `relevant`",
+ "type": "string"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_listings_search_live5 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "categories": [
- "pizza_restaurant"
- ],
- "description": "pizza",
- "filters": [
- [
- "rating.value",
- ">",
- 3
- ]
- ],
- "is_claimed": true,
- "limit": 3,
- "location_coordinate": "53.476225,-2.243572,10",
- "order_by": [
- "rating.value,desc"
- ],
- "title": "pizza"
- }
-]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "categories": [
- "pizza_restaurant"
- ],
- "description": "pizza",
- "filters": [
- [
- "rating.value",
- ">",
- 3
- ]
- ],
- "is_claimed": true,
- "limit": 3,
- "location_coordinate": "53.476225,-2.243572,10",
- "order_by": [
- "rating.value,desc"
- ],
- "title": "pizza"
- }
- ],
- "properties": {
- "categories": {
- "description": "<em>business categories</em><br>optional field<br>the categories you specify are used to search for business listings;<br>if you don't use this field, we will return business listings found in the specified location;<br>you can specify <strong>up to 10 categories</strong>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "description": {
- "description": "<em>description of the element in SERP</em><br>optional field<br>the description of the business entity for which the results are collected;<br>can contain up to 200 characters",
- "type": [
- "string",
- "null"
- ]
- },
- "filters": {
- "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><br>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/business_listings/available_filters</code><br>The full list of possible filters is available <a href=\"/v3/business_data/business_listings/filters\" rel=\"noopener noreferrer\" target=\"_blank\">here.</a>n",
- "items": {
- "type": [
- "object",
- "null"
- ]
- },
- "type": [
- "array",
- "null"
- ]
- },
- "is_claimed": {
- "description": "<em>indicates whether the business is verified by its owner on Google Maps</em><br>optional field",
- "type": [
- "boolean",
- "null"
- ]
- },
- "limit": {
- "description": "<em>the maximum number of returned businesses</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
- "type": [
- "integer",
- "null"
- ]
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br>optional field<br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the value of <em>\"radius\"</em> is specified in kilometres (km)<br>the minimum value for <em>\"radius\"</em>: <code>1</code><br>the maximum value for <em>\"radius\"</em>: <code>100000</code><br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code><br>learn more about how to set location parameters in this API on our <a href=\"https://dataforseo.com/help-center/how-to-specify-location-settings-in-business-listings-api\" target=\"_blank\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "offset": {
- "description": "<em>offset in the results array of returned businesses</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead",
- "type": [
- "integer",
- "null"
- ]
- },
- "offset_token": {
- "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "order_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"rating.value,desc\"]</code><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"rating.value,desc\",\"rating.votes_count,desc\"]</code>",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "title": {
- "description": "<em>title of the element in SERP</em><br>optional field<br>the name of the business entity for which the results are collected;<br>can contain up to 200 characters",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "categories": {
+ "description": "*business categories* optional field the categories you specify are used to search for business listings; if you don’t use this field, we will return business listings found in the specified location; you can specify **up to 10 categories**",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "*description of the element in SERP* optional field the description of the business entity for which the results are collected; can contain up to 200 characters",
+ "type": "string"
+ },
+ "filters": {
+ "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters The full list of possible filters is available here. n",
+ "items": {},
+ "type": "array"
+ },
+ "is_claimed": {
+ "description": "*indicates whether the business is verified by its owner on Google Maps* optional field",
+ "type": "boolean"
+ },
+ "limit": {
+ "description": "*the maximum number of returned businesses* optional field default value: `100` maximum value: `1000`",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "GPS coordinates of a location optional field location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the value of \"radius\" is specified in kilometres (km) the minimum value for \"radius\": 1 the maximum value for \"radius\": 100000 example: 53.476225,-2.243572,200 learn more about how to set location parameters in this API on our Help Center",
+ "type": "string"
+ },
+ "offset": {
+ "description": "offset in the results array of returned businesses optional field default value: 0 if 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 Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead",
+ "type": "integer"
+ },
+ "offset_token": {
+ "description": "token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center",
+ "type": "string"
+ },
+ "order_by": {
+ "description": "*results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` – results will be sorted in the ascending order `desc` – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: `[\"rating.value,desc\"]`**note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `[\"rating.value,desc\",\"rating.votes_count,desc\"]`",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ },
+ "title": {
+ "description": "*title of the element in SERP* optional field the name of the business entity for which the results are collected; can contain up to 200 characters",
+ "type": "string"
+ }
+}Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_tripadvisor_reviews_submit7 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "location_code": 1003854,
- "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
- "tag": "some_string_123",
- "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "url_path"
+ ]
+ },
+ {
+ "required": [
+ "keyword"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "url_path"
+ ]
+ },
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "location_code": 1003854,
- "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
- "tag": "some_string_123",
- "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP;<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;<br>default value: <code>10</code>;<br>max value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field if you do not specify <code>url_path</code></strong><br>the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<em><br></em><code class=\"long-string\">en</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "string",
- "null"
- ]
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<br><code class=\"long-string\">English</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "string",
- "null"
- ]
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
- "type": "integer"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "months": {
- "description": "<em>filter by months when a traveler made a visit</em><br>optional field<br>possible values: <code>january</code>, <code>february</code>, <code>march</code>, <code>april</code>, <code>may</code>, <code>april</code>, <code>june</code>, <code>july</code>, <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code>, <code>december</code><br>you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "ratings": {
- "description": "<em>Tripadvisor traveler rating for a place of interest</em><br>optional field<br>rating based on the written reviews by a traveler after they visited a place.<br>possible values: <code>excellent</code>, <code>very_good</code>, <code>average</code>, <code>poor</code>, <code>terrible</code><br>you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code><br><code>detailed_reviews</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "translate_reviews": {
- "description": "<em>translate reviews according to the URL path</em><br>optional field<br>if set to <code>true</code>, returned reviews will be translated to the language matching the specified <code>url_path</code>;<br>for example, if <code>url_path</code> contains <code>tripadvisor.it</code> and <code>translate_reviews</code> is <code>true</code>, reviews will be translated to the Italian language;<br>default value: <code>true</code><br>you can learn more about how reviews are translated in <a href=\"https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api\" rel=\"noopener noreferrer\" target=\"_blank\">this Help Center article</a>",
- "type": [
- "boolean",
- "null"
- ]
- },
- "url_path": {
- "description": "<em>URL path of the business entity</em><br><strong>required field if you do not specify <code>keyword</code></strong><br>URL path to the Tripadvisor page of the business entity;<br>examples:<br><code>Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code><br><code>https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code>",
- "type": "string"
- },
- "visit_type": {
- "description": "<em>filter by type of travelers who left a review</em><br>optional field<br>possible values: <code>families</code>, <code>couples</code>, <code>solo</code>, <code>business</code>, <code>friends</code><br>you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": [
- "array",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "depth": {
+ "description": "*parsing depth* optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row; default value: `10`; max value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.",
+ "type": "integer"
+ },
+ "keyword": {
+ "description": "*keyword* **required field if you do not specify `url_path`** the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor; you can specify up to 700 characters in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your `keyword`, please specify it as “%25”",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "*search engine language code* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `en` You will be additionally charged for setting a language parameter in this endpoint.",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "*full name of search engine language* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `English` You will be additionally charged for setting a language parameter in this endpoint.",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "*search engine location code* **required field if you don’t specify `location_name` or `url_path`** 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/tripadvisor/locations` example: `1003854`",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "*full name of search engine location* **required field if you don’t specify `location_code` or `url_path`** you 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` example: `London,England,United Kingdom`",
+ "type": "string"
+ },
+ "months": {
+ "description": "*filter by months when a traveler made a visit* optional field possible values: `january`, `february`, `march`, `april`, `may`, `april`, `june`, `july`, `august`, `september`, `october`, `november`, `december` you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pingback_url": {
+ "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "priority": {
+ "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "ratings": {
+ "description": "*Tripadvisor traveler rating for a place of interest* optional field rating based on the written reviews by a traveler after they visited a place. possible values: `excellent`, `very_good`, `average`, `poor`, `terrible` you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "search_reviews_keyword": {
+ "description": "*search reviews containing a specified keyword* example: `dessert`",
+ "type": "string"
+ },
+ "sort_by": {
+ "description": "*results sorting parameters* optional field you can use this field to sort the results; possible types of sorting: `most_recent` `detailed_reviews`",
+ "type": "string"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ },
+ "translate_reviews": {
+ "description": "*translate reviews according to the URL path* optional field if set to `true`, returned reviews will be translated to the language matching the specified `url_path`; for example, if `url_path` contains `tripadvisor.it` and `translate_reviews` is `true`, reviews will be translated to the Italian language; default value: `true` you can learn more about how reviews are translated in [this Help Center article](https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api)",
+ "type": "boolean"
+ },
+ "url_path": {
+ "description": "*URL path of the business entity* **required field if you do not specify `keyword`** URL path to the Tripadvisor page of the business entity; examples: `Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html` `https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html`",
+ "type": "string"
+ },
+ "visit_type": {
+ "description": "*filter by type of travelers who left a review* optional field possible values: `families`, `couples`, `solo`, `business`, `friends` you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+}Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_tripadvisor_search_submit8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "depth": 30,
- "keyword": "pizza",
- "location_code": 1003854
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "depth": 30,
- "keyword": "pizza",
- "location_code": 1003854
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>210</code><p><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category, company name, or a prominent place;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
- "type": "integer"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "depth": {
+ "description": "*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row; default value: `30`; maximum value: `210` **Your account will be billed per each SERP containing up to 30 results;** Setting depth above 30 may result in additional charges if the search engine returns more than 30 results.",
+ "type": "integer"
+ },
+ "keyword": {
+ "description": "*keyword* **required field** the keyword you specify should indicate a business category, company name, or a prominent place; you can specify up to 700 characters in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your `keyword`, please specify it as “%25” learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "*search engine location code* **required field if you don’t specify `location_name`** 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/tripadvisor/locations` example: `1003854`",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "*full name of search engine location* **required field if you don’t specify `location_code`** you 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` example: `London,England,United Kingdom`",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "priority": {
+ "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "keyword"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_trustpilot_reviews_submit7 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "depth": 40,
- "domain": "www.thepearlsource.com"
- }
-]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "depth": 40,
- "domain": "www.thepearlsource.com"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "domain": {
- "description": "<em>domain of the local establishment</em><br><strong>required field</strong><br>domain of the local establishment on Trustpilot;<br>you can find the domain in the URL of every business listed on Trustpilot<br>example:<br><code>www.thepearlsource.com</code><br><code>https://www.trustpilot.com/review/<strong>www.thepearlsource.com</strong></code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting parameter</em><br>optional field<br>you can use this field to sort the results;<br>possible sorting parameters:<br><code>recency</code> — most recent reviews first;<br><code>relevance</code> — most relevant reviews first;<br>default value: <code>relevance</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "depth": {
+ "description": "*parsing depth* optional field number of reviews to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row default value: `20` maximum value: `200` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results.",
+ "type": "integer"
+ },
+ "domain": {
+ "description": "*domain of the local establishment* **required field** domain of the local establishment on Trustpilot; you can find the domain in the URL of every business listed on Trustpilot example: `www.thepearlsource.com` `https://www.trustpilot.com/review/www.thepearlsource.com`",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "priority": {
+ "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "sort_by": {
+ "description": "*results sorting parameter* optional field you can use this field to sort the results; possible sorting parameters: `recency` — most recent reviews first; `relevance` — most relevant reviews first; default value: `relevance`",
+ "type": "string"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "domain"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_business_trustpilot_search_submit7 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "depth": 20,
- "keyword": "pizza restaurant"
- }
-]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "depth": 20,
- "keyword": "pizza restaurant"
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;<br>default value: <code>10</code>;<br>maximum value: <code>140</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category or company name;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "depth": {
+ "description": "*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row; default value: `10`; maximum value: `140` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.",
+ "type": "integer"
+ },
+ "keyword": {
+ "description": "*keyword* **required field** the keyword you specify should indicate a business category or company name; you can specify up to 700 characters in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your `keyword`, please specify it as “%25” learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
+ "type": "string"
+ },
+ "priority": {
+ "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "tag": {
+ "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",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "keyword"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truesearch17 fields changedInput schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Input schema / properties / category / anyOfAdded value: +[
+ {
+ "enum": [
+ "seo",
+ "finance",
+ "social",
+ "search",
+ "sales",
+ "mail"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+]Input schema / properties / category / defaultAdded value: +nullInput schema / properties / category / descriptionPrevious value: -"Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.)"New value: +"Restrict to one category (seo, finance, social, search, sales, mail). Omit to search everything."Input schema / properties / category / enumRemoved value: -[
- "seo",
- "finance",
- "social",
- "search",
- "sales",
- "mail"
-]Input schema / properties / category / typeRemoved value: -"string"Input schema / properties / known_fieldsRemoved value: -{
- "additionalProperties": true,
- "default": {},
- "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.",
- "type": "object"
-}Input schema / properties / limit / descriptionPrevious value: -"Maximum number of additional direct tool candidates."New value: +"Maximum candidates, 1-10"Input schema / properties / limit / maximumRemoved value: -20Input schema / properties / limit / minimumRemoved value: -1Input schema / properties / provider_filtersRemoved value: -{
- "default": [],
- "description": "Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown.",
- "items": {
- "type": "string"
- },
- "maxItems": 50,
- "type": "array",
- "uniqueItems": true
-}Input schema / properties / query / descriptionPrevious value: -"Natural-language capability or task to discover."New value: +"What you need, in plain language, e.g. 'backlinks of a domain', 'recent tweets by a user', 'insider trades for AAPL'. English works best."Input schema / properties / query / maxLengthRemoved value: -2000Input schema / properties / query / minLengthRemoved value: -1Input schema / properties / session_idRemoved value: -{
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "pattern": "^[A-Za-z0-9_-]*$",
- "type": "string"
-}Output schema / propertiesRemoved value: -{
- "next_steps_guidance": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "plan": {
- "additionalProperties": false,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ],
- "properties": {
- "canonical_use_case": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "known_pitfalls": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "plan_ref": {
- "type": "string"
- },
- "primary_tools": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "recommended_steps": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "related_tools": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "canonical_use_case",
- "description",
- "known_pitfalls",
- "plan_ref",
- "primary_tools",
- "recommended_steps",
- "related_tools"
- ]
- },
- "retrieval_mode": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "string"
- }
- ]
- },
- "search_id": {
- "type": "string"
- },
- "session_id": {
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "minLength": 1,
- "pattern": "^[A-Za-z0-9_-]{1,128}$",
- "type": "string"
- },
- "tools": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "additionalProperties": false,
- "properties": {
- "arguments_schema": {
- "additionalProperties": true,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ]
- },
- "description": {
- "type": "string"
- },
- "execution_supported": {
- "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
- "type": "boolean"
- },
- "execution_unsupported_reason": {
- "description": "Why execution and quoting remain unavailable through this router.",
- "type": "string"
- },
- "has_full_schema": {
- "type": "boolean"
- },
- "match_reasons": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "price": {
- "additionalProperties": true,
- "type": "object"
- },
- "retrieval_debug": {
- "additionalProperties": false,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ],
- "properties": {
- "fused_rank": {
- "type": "integer"
- },
- "fused_score": {
- "type": "number"
- },
- "lexical_rank": {
- "type": "integer"
- },
- "lexical_score": {
- "type": "number"
- },
- "rerank_admission_rank": {
- "type": "integer"
- },
- "rerank_rank": {
- "type": "integer"
- },
- "rerank_score": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "number"
- }
- ]
- },
- "runtime_availability": {
- "type": "string"
- },
- "vector_view_ranks": {
- "additionalProperties": {
- "type": "integer"
- },
- "type": "object"
- },
- "vector_view_scores": {
- "additionalProperties": {
- "type": "number"
- },
- "type": "object"
- }
- },
- "required": [
- "fused_rank",
- "fused_score",
- "lexical_rank",
- "lexical_score",
- "rerank_admission_rank",
- "rerank_rank",
- "runtime_availability",
- "vector_view_ranks",
- "vector_view_scores"
- ]
- },
- "summary": {
- "type": "string"
- },
- "tool": {
- "type": "string"
- }
- },
- "required": [
- "description",
- "has_full_schema",
- "price",
- "summary",
- "tool"
- ],
- "type": "object"
- }
- }
-}Output schema / requiredRemoved value: -[
- "next_steps_guidance",
- "search_id",
- "session_id",
- "tools"
-]use1 field changedInput schema / properties / max_price_usd / descriptionPrevious value: -"Refuse the call before any spend if its quoted price is above this many USD"New value: +"Refuse the call before any spend if it would cost more than this many USD"batch_get_schemabatch_quotebatch_use18 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / descriptionRemoved value: -"Up to 20 items of {call_id, operation_id, arguments}; steps at the same execution_level of a plan go in one batch"Input schema / properties / calls / items / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / items / additionalPropertiesPrevious value: -trueNew value: +falseInput schema / properties / calls / items / propertiesAdded value: +{
+ "arguments": {
+ "additionalProperties": true,
+ "description": "Strictly schema-compliant arguments using the exact field names and types from this tool's arguments_schema.",
+ "type": "object"
+ },
+ "call_id": {
+ "description": "Caller-chosen identifier unique within this batch.",
+ "maxLength": 128,
+ "minLength": 1,
+ "type": "string"
+ },
+ "tool": {
+ "description": "Exact tool name returned by search or batch_get_schema. Never invent a name.",
+ "minLength": 1,
+ "type": "string"
+ }
+}Input schema / properties / calls / items / requiredAdded value: +[
+ "call_id",
+ "tool",
+ "arguments"
+]Input schema / properties / calls / maxItemsAdded value: +20Input schema / properties / calls / minItemsAdded value: +1Input schema / properties / max_price_usdRemoved value: -{
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Per-call price cap applied to every item"
-}Input schema / properties / search_id / anyOfRemoved value: -[
- {
- "type": "string"
- },
- {
- "type": "null"
- }
-]Input schema / properties / search_id / defaultRemoved value: -nullInput schema / properties / search_id / descriptionPrevious value: -"search_id from the search that found these operations"New value: +"Optional search correlation identifier returned by search."Input schema / properties / search_id / typeAdded value: +"string"Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Output schema / $defsAdded value: +{
+ "jsonValue": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "type": "object"
+ },
+ {
+ "items": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "JSON value returned by the upstream tool."
+ }
+}Output schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Output schema / propertiesAdded value: +{
+ "batch_id": {
+ "type": "string"
+ },
+ "error_count": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "next_steps_guidance": {
+ "description": "Deterministic next-step instructions derived from this result. Not an authorization grant.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "results": {
+ "items": {
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": false,
+ "properties": {
+ "call_id": {
+ "type": "string"
+ },
+ "customer_cost_micros_usd": {
+ "description": "Actual customer charge settled by AIsaServices, in micro-USD. Omitted when the upstream response does not report it.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "data": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "error": {
+ "anyOf": [
+ {
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": false,
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "retryable": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "integer"
+ },
+ "type": {
+ "enum": [
+ "validation",
+ "authentication",
+ "payment",
+ "permission",
+ "rate_limit",
+ "upstream",
+ "timeout",
+ "internal"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "status",
+ "retryable"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "request_id": {
+ "type": "string"
+ },
+ "successful": {
+ "type": "boolean"
+ },
+ "tool": {
+ "type": "string"
+ },
+ "upstream_status": {
+ "description": "HTTP status returned by AIsaServices when a request was dispatched.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "call_id",
+ "tool",
+ "successful",
+ "request_id"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+ },
+ "success_count": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "total_count": {
+ "minimum": 1,
+ "type": "integer"
+ }
+}Output schema / requiredAdded value: +[
+ "session_id",
+ "batch_id",
+ "total_count",
+ "success_count",
+ "error_count",
+ "results",
+ "next_steps_guidance"
+]get_dataforseo_business_google_extended_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_google_gmb_updates_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_google_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_tripadvisor_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_tripadvisor_search_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_trustpilot_reviews_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_business_trustpilot_search_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_details13 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / argumentsRemoved value: -{
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "The arguments the operation would be called with, for a price that reflects them. Keyed by operation_id for a batch, or passed flat for a single operation_id. Routes whose required parameters are validated before pricing have no price without them."
-}Input schema / properties / include_arguments_schemaAdded value: +{
+ "default": true,
+ "description": "Return the complete arguments_schema. Defaults to true.",
+ "type": "boolean"
+}Input schema / properties / include_documentation / descriptionPrevious value: -"Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged."New value: +"Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support."Input schema / properties / include_response_schemaAdded value: +{
+ "default": false,
+ "description": "Return the complete response_schema. Defaults to false.",
+ "type": "boolean"
+}Input schema / properties / operation_idRemoved value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "One operation_id from search"
-}Input schema / properties / operation_idsRemoved value: -{
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Up to 20 operation_ids, for a batch"
-}Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Input schema / properties / toolsAdded value: +{
+ "description": "Exact tool names returned by search whose complete contracts are needed. Never invent tool names.",
+ "items": {
+ "minLength": 1,
+ "pattern": "^\\S(?:.*\\S)?$",
+ "type": "string"
+ },
+ "maxItems": 20,
+ "minItems": 1,
+ "type": "array",
+ "uniqueItems": true
+}Input schema / properties / with_quoteRemoved value: -{
- "default": true,
- "description": "Whether each operation is priced for this account before the answer. One round trip per operation; spends nothing.",
- "type": "boolean"
-}Input schema / requiredAdded value: +[
+ "tools"
+]Output schema / propertiesAdded value: +{
+ "error_count": {
+ "type": "integer"
+ },
+ "next_steps_guidance": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]{1,128}$",
+ "type": "string"
+ },
+ "success_count": {
+ "type": "integer"
+ },
+ "tools": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "arguments_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "canonical_operation_id": {
+ "type": "string"
+ },
+ "documentation": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "error": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "execution_supported": {
+ "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
+ "type": "boolean"
+ },
+ "execution_unsupported_reason": {
+ "description": "Why execution and quoting remain unavailable through this router.",
+ "type": "string"
+ },
+ "idempotent": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "known_pitfalls": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "read_only": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "response_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "side_effects": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "successful": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "successful"
+ ],
+ "type": "object"
+ },
+ "type": "object"
+ },
+ "total_count": {
+ "type": "integer"
+ }
+}Output schema / requiredAdded value: +[
+ "error_count",
+ "next_steps_guidance",
+ "session_id",
+ "success_count",
+ "tools",
+ "total_count"
+]post_dataforseo_business_google_extended_reviews_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "cid": "17626775537598922320",
+ "language_name": "english",
+ "location_name": "London,England,United Kingdom"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "keyword"
- ]
- },
- {
- "required": [
- "cid"
- ]
- },
- {
- "required": [
- "place_id"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "cid": "17626775537598922320",
+ "language_name": "english",
+ "location_name": "London,England,United Kingdom"
+ }
+ ],
+ "properties": {
+ "cid": {
+ "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>1000</code><p><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>three times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "place_id": {
+ "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" rel=\"noopener noreferrer\" target=\"_blank\">Google Reviews API</a>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "cid": {
- "description": "*unique, google-defined id of the business entity* **required field if you don’t specify `keyword` or `place_id`** example: `194604053573767737` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the Google Reviews API",
- "type": "string"
- },
- "depth": {
- "description": "*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row default value: `20` maximum value: `1000` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field if you don’t specify `cid` or `place_id`** the keyword you specify should indicate the name of the local establishment; you can specify **up to 700 characters** in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, **the charge per task will be multiplied by 5** Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) **Note:** if you use this field, your account will be charged **three times the standard rate** for tasks involving the Google Reviews API",
- "type": "string"
- },
- "language_code": {
- "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 the https://api.dataforseo.com/v3/business_data/google/languages example: enn",
- "type": "string"
- },
- "language_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `English`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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 example: 53.476225,-2.243572,200n",
- "type": "string"
- },
- "location_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/locations` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "place_id": {
- "description": "*identifier of the business entity in Google Maps* **required field if you don’t specify `keyword` or `cid`** example: `GhIJQWDl0CIeQUARxks3icF8U8A` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the Google Reviews API",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_gmb_info_live8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "keyword": {
- "description": "keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; 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:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A learn more about the cid and place_id identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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",
- "type": "string"
- },
- "location_name": {
- "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`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_gmb_updates_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "RustyBrick, Inc.",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of updates in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row<br><strong>please note that Google returns 4490 updates maximum</strong><br>default value: <code>10</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;this field can also be used to pass <code>cid</code> (unique, google-defined id of the business entity) or <code>place_id</code> (identifier of the business entity in Google Maps) parameters<br>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of updates in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row **please note that Google returns 4490 updates maximum** default value: `10`",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field** the keyword you specify should indicate the name of the local establishment you can specify **up to 700 characters** in the `keyword` filed **all %## will be decoded (plus character ‘+’ will be decoded to a space character)** if you need to use the “%” character for your `keyword`, please specify it as “%25”;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 example: `cid:194604053573767737` `place_id:GhIJQWDl0CIeQUARxks3icF8U8A`learn more about the `cid` and `place_id` identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)",
- "type": "string"
- },
- "language_code": {
- "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 the https://api.dataforseo.com/v3/business_data/google/languages example: enn",
- "type": "string"
- },
- "language_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `English`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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 example: 53.476225,-2.243572,200n",
- "type": "string"
- },
- "location_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/locations` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_hotel_info_live8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "hotel_identifier": "CgoI-KWyzenM_MV3EAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "hotel_identifier": "CgoI-KWyzenM_MV3EAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>the value must not be earlier than today's date<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hotel_identifier": {
+ "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "load_prices_by_dates": {
+ "description": "<em>load hotel stay prices by dates</em><br>optional field<br>if you specify this parameter with <code>true</code>, the response will include the <code>prices_by_dates</code> array with hotel stay prices divided by dates<br>if you use this parameter, you will be charged <strong>double the base price for a request</strong>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude, longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "prices_date_range": {
+ "description": "<em>predefined period for retrieving daily price data</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if the <code>prices_start_date </code>is not specified, the start date is set to <code>check_in</code> date<br>possible values: <code>month</code>, <code>three_months</code>, <code>six_months</code>, <code>year</code><br>default value: <code>month</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "prices_end_date": {
+ "description": "<em>end date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, you will get prices by date for the month <br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-21</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "prices_start_date": {
+ "description": "<em>start date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, the start date is set to <code>check_in</code> date<br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-20</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "adults": {
- "description": "*number of adults* optional field if you don’t specify this field, two adults will be used by default example: `1`",
- "type": "integer"
- },
- "check_in": {
- "description": "*check-in date* optional field if you don’t specify this field, tomorrow’s date will be used by default; the value must not be earlier than today’s date date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
- "type": "string"
- },
- "check_out": {
- "description": "*check-out date* optional field if you don’t specify this field, our system will apply the date of two days from now by default; **Note:** the value cannot be less than or equal to `check_in`; the range between `check_in` and `check_out` values cannot exceed 30 days date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
- "type": "string"
- },
- "children": {
- "description": "*number and age of children* optional field if you don’t specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: `[14]` set the following value if you want to include one 13-years-old child and one 8-years-old child: `[13,8]`",
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "currency": {
- "description": "*currency* optional field example: `\"USD\"`",
- "type": "string"
- },
- "hotel_identifier": {
- "description": "*unique hotel identifier* **required field** unique identifier of a hotel entity in Google search; you can obtain the value by making a request to Advanced [Google SERP API](https://docs.dataforseo.com/v3/serp/google/organic/overview.md) (enclosed in the `hotels` element of the response), or the [Hotel Searches endpoint](https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post.md) of Business Data API example: `ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE`",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "load_prices_by_dates": {
- "description": "*load hotel stay prices by dates* optional field if you specify this parameter with `true`, the response will include the `prices_by_dates` array with hotel stay prices divided by dates if you use this parameter, you will be charged **double the base price for a request**",
- "type": "boolean"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_coordinate parameter should be specified in the \"latitude, longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572n",
- "type": "string"
- },
- "location_name": {
- "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`",
- "type": "string"
- },
- "prices_date_range": {
- "description": "*predefined period for retrieving daily price data* optional field to use this parameter, you must specify `load_prices_by_dates` with `true` if the `prices_start_date `is not specified, the start date is set to `check_in` date possible values: `month`, `three_months`, `six_months`, `year` default value: `month`",
- "type": "string"
- },
- "prices_end_date": {
- "description": "*end date to load prices by dates* optional field to use this parameter, you must specify `load_prices_by_dates` with `true` if this parameter is not specified, you will get prices by date for the month date format: `yyyy-mm-dd` example: `2025-05-21`",
- "type": "string"
- },
- "prices_start_date": {
- "description": "*start date to load prices by dates* optional field to use this parameter, you must specify `load_prices_by_dates` with `true` if this parameter is not specified, the start date is set to `check_in` date date format: `yyyy-mm-dd` example: `2025-05-20`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "hotel_identifier"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_hotel_info_live_html8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
+ "language_code": "en",
+ "location_name": "New York,New York,United States"
+ }
+ ],
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, two adults will be used by default<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hotel_identifier": {
+ "description": "<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href=\"/v3/serp/google/organic/overview/\" rel=\"noopener noreferrer\" target=\"_blank\">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href=\"/v3/business_data/google/hotel_searches/task_post/\" rel=\"noopener noreferrer\" target=\"_blank\">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-hotels-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "adults": {
- "description": "*number of adults* optional field if you don’t specify this field, two adults will be used by default example: `1`",
- "type": "integer"
- },
- "check_in": {
- "description": "*check-in date* optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
- "type": "string"
- },
- "check_out": {
- "description": "*check-out date* optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"`",
- "type": "string"
- },
- "children": {
- "description": "*number and age of children* optional field if you don’t specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: `[14]` set the following value if you want to include one 13-years-old child and one 8-years-old child: `[13,8]`",
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "currency": {
- "description": "*currency* optional field example: `\"USD\"`",
- "type": "string"
- },
- "hotel_identifier": {
- "description": "*unique hotel identifier* **required field** unique identifier of a hotel entity in Google search; you can obtain the value by making a request to Advanced [Google SERP API](https://docs.dataforseo.com/v3/serp/google/organic/overview.md) (enclosed in the `hotels` element of the response), or the [Hotel Searches endpoint](https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post.md) of Business Data API example: `ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE`",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_coordinate parameter should be specified in the \"latitude,longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572n",
- "type": "string"
- },
- "location_name": {
- "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`",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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` array of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "hotel_identifier"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_hotel_searches_live7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "adults": 2,
+ "check_in": "2023-06-01",
+ "check_out": "2023-06-30",
+ "children": [
+ "14"
+ ],
+ "currency": "USD",
+ "keyword": "cheap hotel",
+ "language_code": "en",
+ "location_name": "New York,New York,United States",
+ "priority": 2,
+ "sort_by": "highest_rating",
+ "tag": "example"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "adults": 2,
+ "check_in": "2023-06-01",
+ "check_out": "2023-06-30",
+ "children": [
+ "14"
+ ],
+ "currency": "USD",
+ "keyword": "cheap hotel",
+ "language_code": "en",
+ "location_name": "New York,New York,United States",
+ "priority": 2,
+ "sort_by": "highest_rating",
+ "tag": "example"
+ }
+ ],
+ "properties": {
+ "adults": {
+ "description": "<em>number of adults</em><br>optional field<br>if you don't specify this field, the default value of <code>2</code> will be applied;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>example:<br><code>1</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "amenities": {
+ "description": "<em>hotel amenities</em><br>optional field<br>you can use this field to specify different hotel amenities<br>example:<br><code> [<br> \"free_parking\",<br> \"pets_allowed\"<br> ]<br></code><br>possible values:<br>`\"air_conditioning\",<br>\"all_inclusive_available\",<br>\"bar\",<br>\"free_breakfast\",<br>\"fitness_center\",<br>\"kid_friendly\",<br>\"free_parking\",<br>\"pets_allowed\",<br>\"pool\",<br>\"restaurant\",<br>\"room_service\",<br>\"spa\",<br>\"free_wifi\",<br>\"parking\",<br>\"indoor_pool\",<br>\"outdoor_pool\",<br>\"wheelchair_accessible\",<br>\"beach_access\"`",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "check_in": {
+ "description": "<em>check-in date</em><br>optional field<br>if you don't specify this field, tomorrow's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot precede the today's date",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "check_out": {
+ "description": "<em>check-out date</em><br>optional field<br>if you don't specify this field, our system will apply the date of two days from now by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2019-01-15\"</code><br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "children": {
+ "description": "<em>number and age of children</em><br>optional field<br>if you don't specify this field, no children will be included in the search;<br>age of child can be from <code>0</code> to <code>17</code>;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>set the following value if you want to include one 14-year-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-year-old child and one 8-year-old child:<br><code>[13,8]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "currency": {
+ "description": "<em>currency</em><br>optional field<br>example:<br><code>\"USD\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results in Google Hotels<br>default value: <code>18</code> organic results<br>max value: <code>140</code><br><strong>Note:</strong> your account will be billed per each 18 organic results regardless of paid listings in the response;<br>thus, setting a depth above <code>18</code> may result in additional charges if Google Hotels return more than 18 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "free_cancellation": {
+ "description": "<em>hotels with a free cancellation</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of hotels with free cancellation of reservations<br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "is_vacation_rentals": {
+ "description": "<em>search for vacation rentals</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of vacation rentals instead of hotels<br>default value: <code>false</code>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br>optional field<br>the keyword you specify is used to search for the list of hotels;<br>if you don't use this field, we will return the list of hotels found in a specified location;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <br><strong>Note:</strong> in order to obtain accurate search results, the location name is appended to the keyword automatically<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement<br>example:<br><code class=\"long-string\">53.476225,-2.243572</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code><br><strong>Note:</strong> in order to obtain accurate search results, the <code>location_name</code> you specify will be automatically appended to the keyword",
+ "type": "string"
+ },
+ "max_price": {
+ "description": "<em>maximum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>600</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "min_price": {
+ "description": "<em>minimum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>100</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "min_rating": {
+ "description": "<em>minimum rating</em><br>optional field<br>you can use this field to specify guest rating higher than a certain value<br>example:<br><code>2.5</code>",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "search_this_area": {
+ "description": "<em>show hotels from the displayed area</em><br>optional field<br>can take the values: <code>true</code>, <code>false</code><br>default value: <code>true</code><br>if set to <code>false</code> the <code>search_this_area</code> mode will be turned off<br><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, the <code>location_name</code> won't be appended to the <code>keyword</code> during search<br>learn more about this parameter <a href=\"https://dataforseo.com/help-center/how-to-use-search_this_area-parameter-in-google-hotel-searches\" target=\"_blank\">on our Help Center</a>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>relevance</code> – sort by most relevant<br><code>lowest_price</code> – sort by the lowest price<br><code>highest_rating</code> – sort by highest rating<br><code>most_reviewed</code> – sort by most reviewed<br>default value: <code>relevance</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "stars": {
+ "description": "<em>hotel stars</em><br>optional field<br>set this field to <code>[5]</code> if you want to get the list of 5-star hotels only<br>example:<br><code>[3,4,5]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "adults": {
- "description": "*number of adults* optional field if you don’t specify this field, the default value of `2` will be applied; **note** that you can specify up to 6 persons including both adults and children example: `1`",
- "type": "integer"
- },
- "amenities": {
- "description": "*hotel amenities* optional field you can use this field to specify different hotel amenities example: ` [ \"free_parking\", \"pets_allowed\" ]` possible values: `\"air_conditioning\",\"all_inclusive_available\",\"bar\",\"free_breakfast\",\"fitness_center\",\"kid_friendly\",\"free_parking\",\"pets_allowed\",\"pool\",\"restaurant\",\"room_service\",\"spa\",\"free_wifi\",\"parking\",\"indoor_pool\",\"outdoor_pool\",\"wheelchair_accessible\",\"beach_access\"`",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "check_in": {
- "description": "*check-in date* optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"` **Note:** the value cannot precede the today’s date",
- "type": "string"
- },
- "check_out": {
- "description": "*check-out date* optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: `\"yyyy-mm-dd\"` example: `\"2019-01-15\"` **Note:** the value cannot be less than or equal to `check_in`; the range between `check_in` and `check_out` values cannot exceed 30 days",
- "type": "string"
- },
- "children": {
- "description": "*number and age of children* optional field if you don’t specify this field, no children will be included in the search; age of child can be from `0` to `17`; **note** that you can specify up to 6 persons including both adults and children set the following value if you want to include one 14-year-old child: `[14]` set the following value if you want to include one 13-year-old child and one 8-year-old child: `[13,8]`",
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "currency": {
- "description": "*currency* optional field example: `\"USD\"`",
- "type": "string"
- },
- "depth": {
- "description": "parsing depth optional field number of results in Google Hotels default value: 18 organic results max value: 140 Note: your account will be billed per each 18 organic results regardless of paid listings in the response; thus, setting a depth above 18 may result in additional charges if Google Hotels return more than 18 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance",
- "type": "integer"
- },
- "free_cancellation": {
- "description": "*hotels with a free cancellation* optional field set this field to `true` if you want to get the list of hotels with free cancellation of reservations default value: `false`",
- "type": "boolean"
- },
- "is_vacation_rentals": {
- "description": "*search for vacation rentals* optional field set this field to `true` if you want to get the list of vacation rentals instead of hotels default value: `false`",
- "type": "boolean"
- },
- "keyword": {
- "description": "*keyword* optional field the keyword you specify is used to search for the list of hotels; if you don’t use this field, we will return the list of hotels found in a specified location; you can specify **up to 700 characters** in the `keyword` filed **all %## will be decoded (plus character ‘+’ will be decoded to a space character)** if you need to use the “%” character for your `keyword`, please specify it as “%25”; **Note:** in order to obtain accurate search results, the location name is appended to the keyword automatically learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_coordinate parameter should be specified in the \"latitude,longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement example: 53.476225,-2.243572n",
- "type": "string"
- },
- "location_name": {
- "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` **Note:** in order to obtain accurate search results, the `location_name` you specify will be automatically appended to the keyword",
- "type": "string"
- },
- "max_price": {
- "description": "*maximum price per night* optional field the currency of this value depends on the `currency` field example: `600`",
- "type": "integer"
- },
- "min_price": {
- "description": "*minimum price per night* optional field the currency of this value depends on the `currency` field example: `100`",
- "type": "integer"
- },
- "min_rating": {
- "description": "*minimum rating* optional field you can use this field to specify guest rating higher than a certain value example: `2.5`",
- "type": "number"
- },
- "sort_by": {
- "description": "*results sorting parameters* optional field you can use this field to sort the results possible types of sorting: `relevance` – sort by most relevant `lowest_price` – sort by the lowest price `highest_rating` – sort by highest rating `most_reviewed` – sort by most reviewed default value: `relevance`",
- "type": "string"
- },
- "stars": {
- "description": "*hotel stars* optional field set this field to `[5]` if you want to get the list of 5-star hotels only example: `[3,4,5]`",
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_qa_live8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "The Last Bookstore",
+ "language_code": "en",
+ "location_name": "Los Angeles,California,United States"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "The Last Bookstore",
+ "language_code": "en",
+ "location_name": "Los Angeles,California,United States"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>100</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9 (mm)<br>the maximum value for <em>\"radius\"</em>: 199999 (mm)<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>n",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of results in SERP default value: `20` max value: `100` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance.",
- "type": "integer"
- },
- "keyword": {
- "description": "keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; 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:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A learn more about the cid and place_id identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "language_code": {
- "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",
- "type": "string"
- },
- "language_name": {
- "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`",
- "type": "string"
- },
- "location_code": {
- "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",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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",
- "type": "string"
- },
- "location_name": {
- "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`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_google_reviews_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "depth": 50,
+ "keyword": "hedonism wines",
+ "language_name": "English",
+ "location_name": "London,England,United Kingdom",
+ "sort_by": "highest_rating"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "keyword"
- ]
- },
- {
- "required": [
- "cid"
- ]
- },
- {
- "required": [
- "place_id"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 50,
+ "keyword": "hedonism wines",
+ "language_name": "English",
+ "location_name": "London,England,United Kingdom",
+ "sort_by": "highest_rating"
+ }
+ ],
+ "properties": {
+ "cid": {
+ "description": "<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row<br>default value: <code>10</code><br>maximum value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "place_id": {
+ "description": "<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/what-is-cid-place-id-feature-id\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/google-reviews-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>newest</code> – sort by newest first<br><code>highest_rating</code> – sort by highest rating<br><code>lowest_rating</code> – sort by lowest rating<br><code>relevant</code> – sort by relevance<br>default value: <code>relevant</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "cid": {
- "description": "*unique, google-defined id of the business entity* **required field if you don’t specify `keyword` or `place_id`** example: `194604053573767737` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)",
- "type": "string"
- },
- "depth": {
- "description": "*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row default value: `10` maximum value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field if you don’t specify `cid` or `place_id`** the keyword you specify should indicate the name of the local establishment; you can specify **up to 700 characters** in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, **the charge per task will be multiplied by 5** Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "language_code": {
- "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 the https://api.dataforseo.com/v3/business_data/google/languages example: en",
- "type": "string"
- },
- "language_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `English`",
- "type": "string"
- },
- "location_code": {
- "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: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "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_code location_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 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "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 the `https://api.dataforseo.com/v3/business_data/google/locations` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "place_id": {
- "description": "*identifier of the business entity in Google Maps* **required field if you don’t specify `keyword` or `cid`** example: `GhIJQWDl0CIeQUARxks3icF8U8A` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "sort_by": {
- "description": "*results sorting parameters* optional field you can use this field to sort the results possible types of sorting: `newest` – sort by newest first `highest_rating` – sort by highest rating `lowest_rating` – sort by lowest rating `relevant` – sort by relevance default value: `relevant`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_listings_search_live5 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "categories": [
+ "pizza_restaurant"
+ ],
+ "description": "pizza",
+ "filters": [
+ [
+ "rating.value",
+ ">",
+ 3
+ ]
+ ],
+ "is_claimed": true,
+ "limit": 3,
+ "location_coordinate": "53.476225,-2.243572,10",
+ "order_by": [
+ "rating.value,desc"
+ ],
+ "title": "pizza"
+ }
+]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "categories": [
+ "pizza_restaurant"
+ ],
+ "description": "pizza",
+ "filters": [
+ [
+ "rating.value",
+ ">",
+ 3
+ ]
+ ],
+ "is_claimed": true,
+ "limit": 3,
+ "location_coordinate": "53.476225,-2.243572,10",
+ "order_by": [
+ "rating.value,desc"
+ ],
+ "title": "pizza"
+ }
+ ],
+ "properties": {
+ "categories": {
+ "description": "<em>business categories</em><br>optional field<br>the categories you specify are used to search for business listings;<br>if you don't use this field, we will return business listings found in the specified location;<br>you can specify <strong>up to 10 categories</strong>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "description": {
+ "description": "<em>description of the element in SERP</em><br>optional field<br>the description of the business entity for which the results are collected;<br>can contain up to 200 characters",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "filters": {
+ "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><br>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/business_listings/available_filters</code><br>The full list of possible filters is available <a href=\"/v3/business_data/business_listings/filters\" rel=\"noopener noreferrer\" target=\"_blank\">here.</a>n",
+ "items": {
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "is_claimed": {
+ "description": "<em>indicates whether the business is verified by its owner on Google Maps</em><br>optional field",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "limit": {
+ "description": "<em>the maximum number of returned businesses</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br>optional field<br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the value of <em>\"radius\"</em> is specified in kilometres (km)<br>the minimum value for <em>\"radius\"</em>: <code>1</code><br>the maximum value for <em>\"radius\"</em>: <code>100000</code><br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code><br>learn more about how to set location parameters in this API on our <a href=\"https://dataforseo.com/help-center/how-to-specify-location-settings-in-business-listings-api\" target=\"_blank\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "offset": {
+ "description": "<em>offset in the results array of returned businesses</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "offset_token": {
+ "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "order_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"rating.value,desc\"]</code><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"rating.value,desc\",\"rating.votes_count,desc\"]</code>",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "title": {
+ "description": "<em>title of the element in SERP</em><br>optional field<br>the name of the business entity for which the results are collected;<br>can contain up to 200 characters",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "categories": {
- "description": "*business categories* optional field the categories you specify are used to search for business listings; if you don’t use this field, we will return business listings found in the specified location; you can specify **up to 10 categories**",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "description": {
- "description": "*description of the element in SERP* optional field the description of the business entity for which the results are collected; can contain up to 200 characters",
- "type": "string"
- },
- "filters": {
- "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters The full list of possible filters is available here. n",
- "items": {},
- "type": "array"
- },
- "is_claimed": {
- "description": "*indicates whether the business is verified by its owner on Google Maps* optional field",
- "type": "boolean"
- },
- "limit": {
- "description": "*the maximum number of returned businesses* optional field default value: `100` maximum value: `1000`",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location optional field location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the value of \"radius\" is specified in kilometres (km) the minimum value for \"radius\": 1 the maximum value for \"radius\": 100000 example: 53.476225,-2.243572,200 learn more about how to set location parameters in this API on our Help Center",
- "type": "string"
- },
- "offset": {
- "description": "offset in the results array of returned businesses optional field default value: 0 if 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 Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead",
- "type": "integer"
- },
- "offset_token": {
- "description": "token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center",
- "type": "string"
- },
- "order_by": {
- "description": "*results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` – results will be sorted in the ascending order `desc` – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: `[\"rating.value,desc\"]`**note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `[\"rating.value,desc\",\"rating.votes_count,desc\"]`",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "tag": {
- "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",
- "type": "string"
- },
- "title": {
- "description": "*title of the element in SERP* optional field the name of the business entity for which the results are collected; can contain up to 200 characters",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_tripadvisor_reviews_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "location_code": 1003854,
+ "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
+ "tag": "some_string_123",
+ "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "url_path"
- ]
- },
- {
- "required": [
- "keyword"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "url_path"
- ]
- },
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "location_code": 1003854,
+ "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
+ "tag": "some_string_123",
+ "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP;<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;<br>default value: <code>10</code>;<br>max value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field if you do not specify <code>url_path</code></strong><br>the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<em><br></em><code class=\"long-string\">en</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<br><code class=\"long-string\">English</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "months": {
+ "description": "<em>filter by months when a traveler made a visit</em><br>optional field<br>possible values: <code>january</code>, <code>february</code>, <code>march</code>, <code>april</code>, <code>may</code>, <code>april</code>, <code>june</code>, <code>july</code>, <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code>, <code>december</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "ratings": {
+ "description": "<em>Tripadvisor traveler rating for a place of interest</em><br>optional field<br>rating based on the written reviews by a traveler after they visited a place.<br>possible values: <code>excellent</code>, <code>very_good</code>, <code>average</code>, <code>poor</code>, <code>terrible</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code><br><code>detailed_reviews</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "translate_reviews": {
+ "description": "<em>translate reviews according to the URL path</em><br>optional field<br>if set to <code>true</code>, returned reviews will be translated to the language matching the specified <code>url_path</code>;<br>for example, if <code>url_path</code> contains <code>tripadvisor.it</code> and <code>translate_reviews</code> is <code>true</code>, reviews will be translated to the Italian language;<br>default value: <code>true</code><br>you can learn more about how reviews are translated in <a href=\"https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api\" rel=\"noopener noreferrer\" target=\"_blank\">this Help Center article</a>",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "url_path": {
+ "description": "<em>URL path of the business entity</em><br><strong>required field if you do not specify <code>keyword</code></strong><br>URL path to the Tripadvisor page of the business entity;<br>examples:<br><code>Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code><br><code>https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code>",
+ "type": "string"
+ },
+ "visit_type": {
+ "description": "<em>filter by type of travelers who left a review</em><br>optional field<br>possible values: <code>families</code>, <code>couples</code>, <code>solo</code>, <code>business</code>, <code>friends</code><br>you can specify several values at once",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row; default value: `10`; max value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field if you do not specify `url_path`** the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor; you can specify up to 700 characters in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your `keyword`, please specify it as “%25”",
- "type": "string"
- },
- "language_code": {
- "description": "*search engine language code* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `en` You will be additionally charged for setting a language parameter in this endpoint.",
- "type": "string"
- },
- "language_name": {
- "description": "*full name of search engine language* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `English` You will be additionally charged for setting a language parameter in this endpoint.",
- "type": "string"
- },
- "location_code": {
- "description": "*search engine location code* **required field if you don’t specify `location_name` or `url_path`** 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/tripadvisor/locations` example: `1003854`",
- "type": "integer"
- },
- "location_name": {
- "description": "*full name of search engine location* **required field if you don’t specify `location_code` or `url_path`** you 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` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "months": {
- "description": "*filter by months when a traveler made a visit* optional field possible values: `january`, `february`, `march`, `april`, `may`, `april`, `june`, `july`, `august`, `september`, `october`, `november`, `december` you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "ratings": {
- "description": "*Tripadvisor traveler rating for a place of interest* optional field rating based on the written reviews by a traveler after they visited a place. possible values: `excellent`, `very_good`, `average`, `poor`, `terrible` you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "search_reviews_keyword": {
- "description": "*search reviews containing a specified keyword* example: `dessert`",
- "type": "string"
- },
- "sort_by": {
- "description": "*results sorting parameters* optional field you can use this field to sort the results; possible types of sorting: `most_recent` `detailed_reviews`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- },
- "translate_reviews": {
- "description": "*translate reviews according to the URL path* optional field if set to `true`, returned reviews will be translated to the language matching the specified `url_path`; for example, if `url_path` contains `tripadvisor.it` and `translate_reviews` is `true`, reviews will be translated to the Italian language; default value: `true` you can learn more about how reviews are translated in [this Help Center article](https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api)",
- "type": "boolean"
- },
- "url_path": {
- "description": "*URL path of the business entity* **required field if you do not specify `keyword`** URL path to the Tripadvisor page of the business entity; examples: `Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html` `https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html`",
- "type": "string"
- },
- "visit_type": {
- "description": "*filter by type of travelers who left a review* optional field possible values: `families`, `couples`, `solo`, `business`, `friends` you can specify several values at once",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_tripadvisor_search_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "depth": 30,
+ "keyword": "pizza",
+ "location_code": 1003854
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 30,
+ "keyword": "pizza",
+ "location_code": 1003854
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>210</code><p><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category, company name, or a prominent place;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
+ "type": "integer"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row; default value: `30`; maximum value: `210` **Your account will be billed per each SERP containing up to 30 results;** Setting depth above 30 may result in additional charges if the search engine returns more than 30 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field** the keyword you specify should indicate a business category, company name, or a prominent place; you can specify up to 700 characters in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your `keyword`, please specify it as “%25” learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "location_code": {
- "description": "*search engine location code* **required field if you don’t specify `location_name`** 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/tripadvisor/locations` example: `1003854`",
- "type": "integer"
- },
- "location_name": {
- "description": "*full name of search engine location* **required field if you don’t specify `location_code`** you 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` example: `London,England,United Kingdom`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_trustpilot_reviews_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "depth": 40,
+ "domain": "www.thepearlsource.com"
+ }
+]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 40,
+ "domain": "www.thepearlsource.com"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "domain": {
+ "description": "<em>domain of the local establishment</em><br><strong>required field</strong><br>domain of the local establishment on Trustpilot;<br>you can find the domain in the URL of every business listed on Trustpilot<br>example:<br><code>www.thepearlsource.com</code><br><code>https://www.trustpilot.com/review/<strong>www.thepearlsource.com</strong></code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting parameter</em><br>optional field<br>you can use this field to sort the results;<br>possible sorting parameters:<br><code>recency</code> — most recent reviews first;<br><code>relevance</code> — most relevant reviews first;<br>default value: <code>relevance</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of reviews to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row default value: `20` maximum value: `200` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results.",
- "type": "integer"
- },
- "domain": {
- "description": "*domain of the local establishment* **required field** domain of the local establishment on Trustpilot; you can find the domain in the URL of every business listed on Trustpilot example: `www.thepearlsource.com` `https://www.trustpilot.com/review/www.thepearlsource.com`",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "sort_by": {
- "description": "*results sorting parameter* optional field you can use this field to sort the results; possible sorting parameters: `recency` — most recent reviews first; `relevance` — most relevant reviews first; default value: `relevance`",
- "type": "string"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "domain"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_business_trustpilot_search_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "depth": 20,
+ "keyword": "pizza restaurant"
+ }
+]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "depth": 20,
+ "keyword": "pizza restaurant"
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;<br>default value: <code>10</code>;<br>maximum value: <code>140</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category or company name;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row; default value: `10`; maximum value: `140` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "*keyword* **required field** the keyword you specify should indicate a business category or company name; you can specify up to 700 characters in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your `keyword`, please specify it as “%25” learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)",
- "type": "string"
- },
- "pingback_url": {
- "description": "*notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)",
- "type": "string"
- },
- "priority": {
- "description": "*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "tag": {
- "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",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truesearch17 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / category / anyOfRemoved value: -[
- {
- "enum": [
- "seo",
- "finance",
- "social",
- "search",
- "sales",
- "mail"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
-]Input schema / properties / category / defaultRemoved value: -nullInput schema / properties / category / descriptionPrevious value: -"Restrict to one category (seo, finance, social, search, sales, mail). Omit to search everything."New value: +"Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.)"Input schema / properties / category / enumAdded value: +[
+ "seo",
+ "finance",
+ "social",
+ "search",
+ "sales",
+ "mail"
+]Input schema / properties / category / typeAdded value: +"string"Input schema / properties / known_fieldsAdded value: +{
+ "additionalProperties": true,
+ "default": {},
+ "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.",
+ "type": "object"
+}Input schema / properties / limit / descriptionPrevious value: -"Maximum candidates, 1-10"New value: +"Maximum number of additional direct tool candidates."Input schema / properties / limit / maximumAdded value: +20Input schema / properties / limit / minimumAdded value: +1Input schema / properties / provider_filtersAdded value: +{
+ "default": [],
+ "description": "Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 50,
+ "type": "array",
+ "uniqueItems": true
+}Input schema / properties / query / descriptionPrevious value: -"What you need, in plain language, e.g. 'backlinks of a domain', 'recent tweets by a user', 'insider trades for AAPL'. English works best."New value: +"Natural-language capability or task to discover."Input schema / properties / query / maxLengthAdded value: +2000Input schema / properties / query / minLengthAdded value: +1Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Output schema / propertiesAdded value: +{
+ "next_steps_guidance": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "plan": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "canonical_use_case": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "known_pitfalls": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "plan_ref": {
+ "type": "string"
+ },
+ "primary_tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "recommended_steps": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "related_tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "canonical_use_case",
+ "description",
+ "known_pitfalls",
+ "plan_ref",
+ "primary_tools",
+ "recommended_steps",
+ "related_tools"
+ ]
+ },
+ "retrieval_mode": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "search_id": {
+ "type": "string"
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]{1,128}$",
+ "type": "string"
+ },
+ "tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "arguments_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "execution_supported": {
+ "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
+ "type": "boolean"
+ },
+ "execution_unsupported_reason": {
+ "description": "Why execution and quoting remain unavailable through this router.",
+ "type": "string"
+ },
+ "has_full_schema": {
+ "type": "boolean"
+ },
+ "match_reasons": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "price": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "retrieval_debug": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "fused_rank": {
+ "type": "integer"
+ },
+ "fused_score": {
+ "type": "number"
+ },
+ "lexical_rank": {
+ "type": "integer"
+ },
+ "lexical_score": {
+ "type": "number"
+ },
+ "rerank_admission_rank": {
+ "type": "integer"
+ },
+ "rerank_rank": {
+ "type": "integer"
+ },
+ "rerank_score": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "runtime_availability": {
+ "type": "string"
+ },
+ "vector_view_ranks": {
+ "additionalProperties": {
+ "type": "integer"
+ },
+ "type": "object"
+ },
+ "vector_view_scores": {
+ "additionalProperties": {
+ "type": "number"
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "fused_rank",
+ "fused_score",
+ "lexical_rank",
+ "lexical_score",
+ "rerank_admission_rank",
+ "rerank_rank",
+ "runtime_availability",
+ "vector_view_ranks",
+ "vector_view_scores"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "tool": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "description",
+ "has_full_schema",
+ "price",
+ "summary",
+ "tool"
+ ],
+ "type": "object"
+ }
+ }
+}Output schema / requiredAdded value: +[
+ "next_steps_guidance",
+ "search_id",
+ "session_id",
+ "tools"
+]use1 field changedInput schema / properties / max_price_usd / descriptionPrevious value: -"Refuse the call before any spend if it would cost more than this many USD"New value: +"Refuse the call before any spend if its quoted price is above this many USD"get_details1 field changedInput schema / properties / include_documentationAdded value: +{
+ "default": false,
+ "description": "Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged.",
+ "type": "boolean"
+}post_dataforseo_business_google_extended_reviews_submit5 fields changedInput schema / properties / body / items / properties / cid / descriptionPrevious value: -"*unique, google-defined id of the business entity* **required field if you don’t specify `keyword` or `place_id`** example: `194604053573767737` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the [Google Reviews API](https://dataforseo.com/pricing/business-data/google-reviews-api)"New value: +"*unique, google-defined id of the business entity* **required field if you don’t specify `keyword` or `place_id`** example: `194604053573767737` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the Google Reviews API"Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row default value: `20` maximum value: `1000` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/google-reviews-api \"Pricing\") page."New value: +"*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row default value: `20` maximum value: `1000` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results."Input schema / properties / body / items / properties / keyword / descriptionPrevious value: -"*keyword* **required field if you don’t specify `cid` or `place_id`** the keyword you specify should indicate the name of the local establishment; you can specify **up to 700 characters** in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, **the charge per task will be multiplied by 5** Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) **Note:** if you use this field, your account will be charged **three times the standard rate** for tasks involving the [Google Reviews API](https://dataforseo.com/pricing/business-data/google-reviews-api)"New value: +"*keyword* **required field if you don’t specify `cid` or `place_id`** the keyword you specify should indicate the name of the local establishment; you can specify **up to 700 characters** in the `keyword` filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your `keyword`, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, **the charge per task will be multiplied by 5** Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) **Note:** if you use this field, your account will be charged **three times the standard rate** for tasks involving the Google Reviews API"Input schema / properties / body / items / properties / place_id / descriptionPrevious value: -"*identifier of the business entity in Google Maps* **required field if you don’t specify `keyword` or `cid`** example: `GhIJQWDl0CIeQUARxks3icF8U8A` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the [Google Reviews API](https://dataforseo.com/pricing/business-data/google-reviews-api)"New value: +"*identifier of the business entity in Google Maps* **required field if you don’t specify `keyword` or `cid`** example: `GhIJQWDl0CIeQUARxks3icF8U8A` learn more about the identifier in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id)**Note:** if you use this field, your account will be charged **two times the standard rate** for tasks involving the Google Reviews API"Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/google-reviews-api \"Pricing\") page."New value: +"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_business_google_gmb_updates_submit1 field changedInput schema / properties / body / items / properties / priority / descriptionPrevious value: -"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api \"Pricing\") page."New value: +"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_business_google_hotel_info_live_html1 field changedInput schema / properties / body / items / properties / priority / descriptionPrevious value: -"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/google-hotels-api \"Pricing\") page."New value: +"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_business_google_qa_live1 field changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"*parsing depth* optional field number of results in SERP default value: `20` max value: `100` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance; The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing \"Pricing\") page."New value: +"*parsing depth* optional field number of results in SERP default value: `20` max value: `100` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance."post_dataforseo_business_google_reviews_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row default value: `10` maximum value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/google-reviews-api \"Pricing\") page."New value: +"*parsing depth* optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row default value: `10` maximum value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/google-reviews-api \"Pricing\") page."New value: +"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_business_tripadvisor_reviews_submit4 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"*parsing depth* optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row; default value: `10`; max value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing \"Pricing\") page."New value: +"*parsing depth* optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row; default value: `10`; max value: `4490` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results."Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"*search engine language code* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `en` You will be additionally charged for setting a language parameter in this endpoint. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing \"Pricing\") page."New value: +"*search engine language code* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `en` You will be additionally charged for setting a language parameter in this endpoint."Input schema / properties / body / items / properties / language_name / descriptionPrevious value: -"*full name of search engine language* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `English` You will be additionally charged for setting a language parameter in this endpoint. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing \"Pricing\") page."New value: +"*full name of search engine language* optional field **if you use this field, your account will be charged for one extra request** you 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` example: `English` You will be additionally charged for setting a language parameter in this endpoint."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing \"Pricing\") page."New value: +"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_business_tripadvisor_search_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row; default value: `30`; maximum value: `210` **Your account will be billed per each SERP containing up to 30 results;** Setting depth above 30 may result in additional charges if the search engine returns more than 30 results; The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing \"Pricing\") page."New value: +"*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row; default value: `30`; maximum value: `210` **Your account will be billed per each SERP containing up to 30 results;** Setting depth above 30 may result in additional charges if the search engine returns more than 30 results."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing \"Pricing\") page."New value: +"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_business_trustpilot_reviews_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"*parsing depth* optional field number of reviews to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row default value: `20` maximum value: `200` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing \"Pricing\") page."New value: +"*parsing depth* optional field number of reviews to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row default value: `20` maximum value: `200` **Your account will be billed per each SERP containing up to 20 results;** Setting depth above 20 may result in additional charges if the search engine returns more than 20 results."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing \"Pricing\") page."New value: +"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_business_trustpilot_search_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row; default value: `10`; maximum value: `140` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing \"Pricing\") page."New value: +"*parsing depth* optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row; default value: `10`; maximum value: `140` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges if the search engine returns more than 10 results."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing \"Pricing\") page."New value: +"*task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."get_dataforseo_business_google_extended_reviews_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"get_dataforseo_business_google_gmb_updates_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"get_dataforseo_business_google_reviews_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"get_dataforseo_business_tripadvisor_reviews_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"get_dataforseo_business_tripadvisor_search_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"get_dataforseo_business_trustpilot_reviews_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"get_dataforseo_business_trustpilot_search_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"post_dataforseo_business_google_extended_reviews_submit4 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"*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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `en`"New value: +"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 the https://api.dataforseo.com/v3/business_data/google/languages example: enn"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"*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: `2840`"New value: +"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"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"*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_code`** `location_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 example: `53.476225,-2.243572,200`"New value: +"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_code location_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 example: 53.476225,-2.243572,200n"Input schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"*return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"post_dataforseo_business_google_gmb_info_live4 fields changedInput schema / properties / body / items / properties / keyword / descriptionPrevious value: -"*keyword* **required field** the keyword you specify should indicate the name of the local establishment you can specify **up to 700 characters** in the `keyword` filed **all %## will be decoded (plus character ‘+’ will be decoded to a space character)** if you need to use the “%” character for your `keyword`, please specify it as “%25”; 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; `spp` – a unique identifier of local services featured in the `local_pack` element of Google SERP example: `cid:194604053573767737` `place_id:GhIJQWDl0CIeQUARxks3icF8U8A` `spp:CgsvZy8xdGN4cWRraBoUChIJPZDrEzLsZIgRoNrpodC5P30` learn more about the `cid` and `place_id` identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)"New value: +"keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; 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:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A learn more about the cid and place_id identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)"Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"*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: `en`"New value: +"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"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"*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: `2840`"New value: +"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"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"*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_code`** `location_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,200`"New value: +"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_code location_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"post_dataforseo_business_google_gmb_updates_submit4 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"*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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `en`"New value: +"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 the https://api.dataforseo.com/v3/business_data/google/languages example: enn"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"*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: `2840`"New value: +"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"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"*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_code`** `location_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 example: `53.476225,-2.243572,200`"New value: +"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_code location_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 example: 53.476225,-2.243572,200n"Input schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"*return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"post_dataforseo_business_google_hotel_info_live3 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"*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: `en`"New value: +"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"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"*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: `2840`"New value: +"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"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"*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_code`** `location_coordinate` parameter should be specified in the *“latitude, longitude”* format the maximum number of decimal digits for *“latitude”* and *“longitude”*: 7 **Note**: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: `53.476225,-2.243572`"New value: +"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_code location_coordinate parameter should be specified in the \"latitude, longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572n"post_dataforseo_business_google_hotel_info_live_html3 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"*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: `en`"New value: +"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"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"*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: `2840`"New value: +"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"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"*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_code`** `location_coordinate` parameter should be specified in the *“latitude,longitude”* format the maximum number of decimal digits for *“latitude”* and *“longitude”*: 7 **Note**: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: `53.476225,-2.243572`"New value: +"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_code location_coordinate parameter should be specified in the \"latitude,longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572n"post_dataforseo_business_google_hotel_searches_live4 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"*parsing depth* optional field number of results in Google Hotels default value: `20` organic results max value: `140` **Note:** your account will be billed per each 20 organic results regardless of paid listings in the response; thus, setting a depth above `20` may result in additional charges if Google Hotels return more than 20 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance"New value: +"parsing depth optional field number of results in Google Hotels default value: 18 organic results max value: 140 Note: your account will be billed per each 18 organic results regardless of paid listings in the response; thus, setting a depth above 18 may result in additional charges if Google Hotels return more than 18 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance"Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"*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: `en`"New value: +"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"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"*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: `2840`"New value: +"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"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"*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_code`** `location_coordinate` parameter should be specified in the *“latitude,longitude”* format the maximum number of decimal digits for *“latitude”* and *“longitude”*: 7 **Note**: if the coordinates are used to set a location, the search will occur in the nearest settlement example: `53.476225,-2.243572`"New value: +"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_code location_coordinate parameter should be specified in the \"latitude,longitude\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement example: 53.476225,-2.243572n"post_dataforseo_business_google_qa_live4 fields changedInput schema / properties / body / items / properties / keyword / descriptionPrevious value: -"*keyword* **required field** the keyword you specify should indicate the name of the local establishment you can specify **up to 700 characters** in the `keyword` filed **all %## will be decoded (plus character ‘+’ will be decoded to a space character)** if you need to use the “%” character for your `keyword`, please specify it as “%25”; 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; `spp` – a unique identifier of local services featured in the `local_pack` element of Google SERP example: `cid:194604053573767737` `place_id:GhIJQWDl0CIeQUARxks3icF8U8A` `spp:CgsvZy8xdGN4cWRraBoUChIJPZDrEzLsZIgRoNrpodC5P30` learn more about the `cid` and `place_id` identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)"New value: +"keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; 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:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A learn more about the cid and place_id identifiers in [this help center article](https://dataforseo.com/help-center/what-is-cid-place-id-feature-id) learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis)"Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"*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: `en`"New value: +"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"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"*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: `2840`"New value: +"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"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"*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_code`** `location_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,200`"New value: +"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_code location_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"post_dataforseo_business_google_reviews_submit4 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"*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 the `https://api.dataforseo.com/v3/business_data/google/languages` example: `en`"New value: +"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 the https://api.dataforseo.com/v3/business_data/google/languages example: en"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"*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: `2840`"New value: +"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: 2840"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"*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_code`** `location_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 example: `53.476225,-2.243572,200`"New value: +"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_code location_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 example: 53.476225,-2.243572,200"Input schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"*return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"post_dataforseo_business_listings_search_live4 fields changedInput schema / properties / body / items / properties / filters / descriptionPrevious value: -"*array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, ``, `>=`, `=`, ``, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `[\"rating.value\",\">\",3]` you can receive the list of available filters by making a separate request to `https://api.dataforseo.com/v3/business_data/business_listings/available_filters`"New value: +"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters The full list of possible filters is available here. n"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"*GPS coordinates of a location* optional field `location_coordinate` parameter should be specified in the *“latitude,longitude,radius”* format the maximum number of decimal digits for *“latitude”* and *“longitude”*: 7 the value of *“radius”* is specified in kilometres (km) the minimum value for *“radius”*: `1` the maximum value for *“radius”*: `100000` example: `53.476225,-2.243572,200`"New value: +"GPS coordinates of a location optional field location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the value of \"radius\" is specified in kilometres (km) the minimum value for \"radius\": 1 the maximum value for \"radius\": 100000 example: 53.476225,-2.243572,200 learn more about how to set location parameters in this API on our Help Center"Input schema / properties / body / items / properties / offset / descriptionPrevious value: -"*offset in the results array of returned businesses* optional field default value: `0` if 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"New value: +"offset in the results array of returned businesses optional field default value: 0 if 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 Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead"Input schema / properties / body / items / properties / offset_token / descriptionPrevious value: -"*token for subsequent requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique `offset_token` value from the response array, you will get the subsequent results of the initial task; `offset_token` values are unique for each subsequent task **Note:** if the `offset_token` is specified in the request, all other parameters should be identical to the previous request"New value: +"token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center"post_dataforseo_business_tripadvisor_reviews_submit1 field changedInput schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"*return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"post_dataforseo_business_tripadvisor_search_submit1 field changedInput schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"*return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"post_dataforseo_business_trustpilot_reviews_submit1 field changedInput schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"*return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"post_dataforseo_business_trustpilot_search_submit1 field changedInput schema / properties / body / items / properties / postback_url / descriptionPrevious value: -"*return URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23`learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"New value: +"URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api)"batch_useget_dataforseo_business_google_extended_reviews_fetchget_dataforseo_business_google_gmb_updates_fetchget_dataforseo_business_google_reviews_fetchget_dataforseo_business_tripadvisor_reviews_fetchget_dataforseo_business_tripadvisor_search_fetchget_dataforseo_business_trustpilot_reviews_fetchget_dataforseo_business_trustpilot_search_fetchget_detailslist_categoriespost_dataforseo_business_google_extended_reviews_submitpost_dataforseo_business_google_gmb_info_livepost_dataforseo_business_google_gmb_updates_submitpost_dataforseo_business_google_hotel_info_livepost_dataforseo_business_google_hotel_info_live_htmlpost_dataforseo_business_google_hotel_searches_livepost_dataforseo_business_google_qa_livepost_dataforseo_business_google_reviews_submitpost_dataforseo_business_listings_search_livepost_dataforseo_business_social_media_pinterest_livepost_dataforseo_business_social_media_reddit_livepost_dataforseo_business_tripadvisor_reviews_submitpost_dataforseo_business_tripadvisor_search_submitpost_dataforseo_business_trustpilot_reviews_submitpost_dataforseo_business_trustpilot_search_submitsearchuseYour agent needs the Google results page as it actually renders — organic and paid, the AI overview, maps, images, news, jobs and the finance panel — not a scraped guess. **What you can ask for** • "What does the SERP for this keyword look like in Germany, on mobile?" • "Does this query trigger an AI overview, and what does it say?" • "Who is advertising against our brand name?" • "Find local results and the map pack for this phrase." • "Search Google by this image and tell me where else it appears." **How to use it** Point any MCP client at https://mcp.aisa.one/seo-serp/mcp and sign in with OAuth — there is no key to create or paste. 38 tools across Google's surfaces: organic, ads and advertisers, AI mode, autocomplete, images, news, maps and local, events, jobs, datasets, scholar, finance quotes and markets, plus Semrush's organic and paid result sets. **Why this rather than the source** Location and language are parameters, so you can read the page a customer in another country sees. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Read the SERP here, then ask the same agent who links to the winner or how much traffic they get — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo-serp-other-engines/mcp for Bing, Yahoo, Baidu, Naver, Seznam and YouTube. https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Your agent needs marketplace data — what a product costs on Amazon and Google Shopping, who the sellers are, what reviewers actually complain about. **What you can ask for** • "What is this ASIN's price history, rating and seller list?" • "Who else sells this product, and at what price?" • "Pull the reviews for this product and group the complaints." • "What comes up on Google Shopping for this query in the UK?" • "Compare these products across both marketplaces." **How to use it** Point any MCP client at https://mcp.aisa.one/seo-merchant/mcp and sign in with OAuth — there is no key to create or paste. 22 tools: Amazon products, ASIN detail and sellers; Google Shopping products, product info, sellers and reviews; live and queued forms, with raw HTML where you need it. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Price the product here, then ask the same agent what the brand's site traffic or ad spend looks like — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Your agent needs the whole search picture — what you rank for, who outranks you, who links to them, what is broken on the site, and whether ChatGPT names you at all. Normally that is three SEO vendors and three subscriptions. **What you can ask for** • "What does this domain rank for, and which competitors take the same keywords?" • "Who links to my competitor and not to me?" • "Crawl this site and list the pages with broken tags or duplicate content." • "Does Perplexity cite us when asked about this category?" • "How hard is this keyword, and what does the SERP look like today?" **How to use it** Point any MCP client at https://mcp.aisa.one/seo/mcp and sign in with OAuth — there is no key to create or paste. 60 tools spanning DataForSEO, Semrush and Ahrefs: SERPs, keywords and difficulty, backlinks and referring domains, on-page crawling, domain authority, and answers from ChatGPT, Claude, Gemini and Perplexity. **Why this rather than the source** Three indexes behind one account, so you can cross-check a number instead of trusting one vendor's version of it. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Check the ranking here, then ask the same agent for that competitor's traffic mix, its ad spend, or the person to email — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** Narrower endpoints: https://mcp.aisa.one/seo-serp/mcp · /seo-keywords/mcp · /seo-backlinks/mcp · /seo-onpage/mcp · /seo-labs/mcp · /seo-ai-visibility/mcp · /seo-content/mcp · /seo-domains/mcp · /seo-business/mcp · /seo-merchant/mcp · /seo-apps/mcp · /seo-serp-other-engines/mcp
Google is not the whole market. Your agent needs Bing, Yahoo, Baidu, Naver, Seznam and YouTube results — the engines that decide whether you exist in China, Korea, Japan or Central Europe. **What you can ask for** • "What ranks for this term on Baidu, and how different is it from Google?" • "Check Naver results for our Korean brand name." • "Compare Bing and Yahoo results for the same query." • "What comes up on YouTube search for this phrase in Japanese?" • "Take a screenshot of the results page as a user there sees it." **How to use it** Point any MCP client at https://mcp.aisa.one/seo-serp-other-engines/mcp and sign in with OAuth — there is no key to create or paste. 34 tools: organic results from Bing, Yahoo, Baidu, Naver and Seznam in live, regular and raw-HTML forms, YouTube search, an AI summary of a result set, and a rendered screenshot. **Why this rather than the source** The engines that matter outside the US, with the same call shape as the Google ones. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Check the local engine here, then ask the same agent what the site's traffic or backlinks look like in that market — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo-serp/mcp for Google itself. https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Add one secure layer between your agents and this server.
