AIsa Domain & Keyword Research
Server Details
Your agent needs the derived numbers — domain authority, what a site ranks for, related and relevant keywords, search intent, and who the real competitors are — for Google, Amazon and the app stores.
What you can ask for • "What is this domain's authority, and how has its rank history moved?" • "Which keywords does this site rank for, and with what intent?" • "Who are this domain's organic competitors, and where do we overlap?" • "Which keywords does this Amazon product rank for?" • "Compare these two domains keyword by keyword."
How to use it Point any MCP client at https://mcp.aisa.one/seo-labs/mcp and sign in with OAuth — there is no key to create or paste. 46 tools: ranked, related and relevant keywords, keyword ideas and intent, domain authority and rank history, competitor and intersection analysis, bulk metrics, plus the same shapes for Amazon products and Apple and Google Play apps.
Why this rather than the source Ahrefs domain rating, Semrush rank history and DataForSEO Labs answering the same questions side by side.
It is also a door to the rest The same login reaches 26 sources and 580+ operations. Size the competitor here, then ask the same agent for their traffic mix or their contacts — 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.
- Status
- Healthy
- Uptime
- 93.6% over 41 days
- OAuth
- Works in Glama
- Last Tested
- Transport
- Streamable HTTP · MCP 2025-11-25
- URL
TDQS
Scored across 53 tools
Most tools target distinct provider endpoints, but there is substantial conceptual overlap: Ahrefs, Semrush, and DataForSEO all expose domain overview or organic keyword metrics, and DataForSEO has many adjacent keyword-discovery endpoints (ideas, suggestions, related, top searches). The deprecated `use` also duplicates `batch_use`, and the search/batch workflow tools add another layer of selection.
Nearly all names use snake_case with a predictable provider/action/endpoint structure (`get_ahrefs_*`, `get_semrush_*`, `post_dataforseo_labs_*`). Minor deviations are the bare meta tools (`account`, `search`, `use`, `list_categories`) and the deprecated `use` versus `batch_use`, but the overall pattern is readable.
53 tools is far beyond a manageable MCP surface and lands in the extreme-mismatch range; even though many are distinct provider endpoints, the set should be split, filtered, or collapsed behind search/batch execution. The large number of near-parallel DataForSEO endpoints makes tool selection costly.
The surface is broad: it covers domain authority/site metrics, organic and paid keyword data, competitors, historical trends, app-store research, and multi-provider keyword discovery. Minor gaps remain around backlink analysis, SERP/rank-tracking operations, and some provider coverage (e.g. Bing endpoints are referenced but not exposed).
Available Tools
53 toolsaccountShow account and usageARead-onlyInspect
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 | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
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.
batch_get_schemaGet AIsa tool schemas in one batchARead-onlyIdempotentInspect
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. |
Output Schema
| 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 |
TDQS
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.
batch_quoteQuote published AIsa tools without executing themARead-onlyIdempotentInspect
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. |
Output Schema
| 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. |
TDQS
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.
batch_useExecute published AIsa toolsADestructiveInspect
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. |
Output Schema
| 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. |
TDQS
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.
get_ahrefs_domain_ratingAhrefs Domain RatingARead-onlyIdempotentInspect
Return the Ahrefs Domain Rating (0-100 authority score) and Ahrefs Rank for a target domain on a given date. 4xx/5xx are not charged.
Published reference price: $0.08 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | Snapshot date in `YYYY-MM-DD` format. | |
| target | Yes | Target domain, e.g. `ahrefs.com`. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly/idempotent/non-destructive/open-world, so the safety profile is covered. The description adds genuinely new behavioral context not in the annotations: error responses (4xx/5xx) are not charged, which matters for an agent deciding whether to retry or validate inputs before spending money.
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 functional sentence is front-loaded, concise, and information-dense. The appended pricing block is boilerplate rather than definitional content, which slightly dilutes the structure but does not bury the core statement.
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 and rich annotations, the description only needs to cover purpose and cost behavior, both of which it does. Missing only a word on which related domain tool to choose when the agent wants broader metrics.
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 date format and target example already documented in the schema, so baseline 3 applies. The description adds only the DR score range, which describes the return value rather than either parameter.
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 (Return) plus two named outputs (Domain Rating, Ahrefs Rank) and defines DR's 0-100 range, so the agent knows exactly what comes back. It does not distinguish itself from sibling tools like get_ahrefs_site_metrics or get_semrush_domain_overview, which is the only gap.
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 prefer this over the adjacent Ahrefs/Semrush domain tools, and no prerequisites or alternative named. The only contextual statement is a billing note, which is not usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_ahrefs_site_metricsAhrefs Site MetricsARead-onlyIdempotentInspect
Return core Site Explorer metrics for a target domain on a given date: organic and paid keyword counts, top-3 keyword count, organic traffic, and traffic value. 4xx/5xx are not charged.
Published reference price: $0.08 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | Snapshot date in `YYYY-MM-DD` format. | |
| target | Yes | Target domain, e.g. `ahrefs.com`. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, openWorld and non-destructive, so safety is covered. The description adds non-obvious billing behavior ('4xx/5xx are not charged') and the $0.08 per successful request cost, which are genuine operational facts the agent cannot get from structured fields.
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 front-loaded and dense with real content, and the error-charging note is short. The delimited aisa-pricing boilerplate is standardized noise rather than authored prose, though it does consume space for a single price figure.
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 structure need not be explained, and both required parameters are fully documented. For a simple two-parameter read tool this is nearly complete; only the lack of any routing context versus the competing Semrush/DataForSEO domain tools leaves a 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 100% (date format/example and target domain example are documented in the schema), so the baseline is 3. The description only restates 'target domain' and 'a given date' without adding format, normalization, or subdomain/path handling detail.
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?
Specific verb ('Return') plus precise resource ('core Site Explorer metrics for a target domain on a given date'), and the enumerated metric list (organic/paid keyword counts, top-3 count, organic traffic, traffic value) differentiates it from near siblings like get_ahrefs_domain_rating and get_semrush_domain_overview.
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, when-not-to-use, or alternative-tool guidance. Given the many Semrush and DataForSEO domain-metric siblings, the agent gets no help deciding between this and get_semrush_domain_overview; only the metric list implicitly suggests a domain-level overview use case.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_labs_available_filtersFilters for DataForSEO Labs APIBRead-onlyIdempotentInspect
Here you will find all the necessary information about filters that can be used with DataForSEO Labs API endpoints.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
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 genuinely useful behavioral context in the pricing note (usage-based billing, ~$0.012 estimate, settlement may vary), but says nothing about the shape or actionable nature of the returned filter metadata.
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 in a single sentence, followed by a clearly marked cost block. No filler beyond the injected pricing boilerplate, and the whole thing is short.
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, and there are no parameters to document. For a zero-arg reference lookup, purpose plus cost is essentially complete; only a hint about how to apply the returned filters to the post_*_live endpoints would improve it.
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 there is nothing for the description to disambiguate. Baseline of 4 applies for a no-argument tool.
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 (filters usable with DataForSEO Labs API endpoints) and effectively identifies this as a reference/discovery tool. The verb is soft ('Here you will find') and it does not distinguish itself from siblings like get_dataforseo_labs_google_available_history or get_dataforseo_labs_status, but the purpose is clear enough for an agent to pick 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?
There is no guidance on when to call this versus the many sibling endpoints, nor any note that it is a prerequisite lookup for constructing filter payloads on the post_*_live tools. The agent must infer the use case entirely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_labs_google_available_historyDataForSEO Labs Google Available HistoryARead-onlyIdempotentInspect
By calling this endpoint, you will find obtain a list of dates available for setting in the first_date and second_date fields of the Domain Metrics by Categories endpoint. for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/available_history/live/?bash'
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive, openWorld), so the bar is lower. The description adds a genuinely useful non-annotation trait: usage-based billing with a default per-request cost estimate, plus a documentation pointer.
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 purpose in the first clause, with the docs link and pricing block kept separate. Slightly marred by the awkward 'you will find obtain' phrasing, but no wasted content.
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 enumerate return values, and it already states the return is a list of available dates. Combined with annotations and a parameterless schema, an agent has what it needs to call this 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 input schema has zero parameters, which is the baseline-4 case. The description correctly frames the tool as parameterless, and there is nothing extra to document.
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 outcome — returning the list of dates that can be used in the first_date/second_date fields of the Domain Metrics by Categories endpoint. That distinguishes it from the many sibling post_dataforseo_labs_* tools, though it references a parent endpoint that is not itself in the sibling list.
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 implies usage by tying the output to first_date/second_date of another endpoint, so an agent can infer 'call this before setting those dates.' It does not state a when-not condition or name an alternative for discovering valid ranges.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_labs_google_categories_for_kw_languagesList of Languages for Google Categories for Keywords APIARead-onlyIdempotentInspect
Using this endpoint you can get the full list of languages supported for the Google Categories for Keywords endpoint of DataForSEO Labs API.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly/idempotent/non-destructive and openWorld, so the safety profile is fully covered. The description adds a genuinely useful behavioral fact beyond the annotations: the usage-based cost estimate (~$0.012). However, it says nothing further about the nature of the response or edge cases; with annotations carrying the load, this is adequate but not rich.
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 purpose is one front-loaded sentence, and the pricing note is confined to a clearly delimited comment block. Minor redundancy (the endpoint is named twice) but overall tight for a simple 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 not be described. For a zero-parameter reference endpoint with full annotation coverage, the description supplies everything an agent needs to invoke it correctly; only explicit routing against siblings is 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?
The schema has zero parameters, so the baseline is 4. There are no parameter semantics to document and the description correctly implies a parameterless lookup.
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+resource: fetching the full list of supported languages for the Google Categories for Keywords endpoint. An agent can tell it is a static reference list tied to that one endpoint, though the description never explicitly contrasts it with siblings like post_dataforseo_labs_google_categories_for_kw_live.
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 by the name (discover supported language codes before calling the categories-for-keywords endpoint), but the description states no when-to-use, no prerequisite, and no alternative. Nothing tells the agent when this lookup is or isn't needed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_labs_statusDataForSEO Labs StatusBRead-onlyIdempotentInspect
By calling this endpoint, you will find out when the DataForSEO Labs data was last updated. The API response will provide separate update dates for the Google, Bing, and Amazon endpoints of DataForSEO Labs API.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
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 fully covered. The description adds useful return-shape context (separate update dates per Google/Bing/Amazon) but says nothing about auth, rate limits, or cost behavior beyond the boilerplate pricing block.
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 functional content is two front-loaded sentences with no waste. The 'By calling this endpoint' lead-in is slightly filler, and the appended pricing boilerplate adds length, but the useful information comes first.
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 no-parameter, read-only status endpoint with an output schema and full annotation coverage, the description supplies what is needed. The output schema handles the return payload, and the description briefly previews its structure; nothing essential 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?
Zero parameters with 100% schema coverage, so the baseline is 4. There is no parameter semantics to explain, and the description correctly does not invent any.
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+resource: discover when DataForSEO Labs data was last updated, and even names the three endpoint families (Google, Bing, Amazon) covered. It is clear what the tool returns, but it does not distinguish itself from sibling status/metadata tools such as get_dataforseo_labs_available_filters or get_dataforseo_labs_google_available_history.
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 preconditions, and no routing to alternatives. The agent can infer this is a freshness/health check, but nothing tells it when checking status is warranted versus simply calling the data endpoint directly.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_semrush_domain_organic_keywordsDomain Organic KeywordsDRead-onlyIdempotentInspect
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| database | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, openWorld and non-destructive, so safety is covered. The description's only added value is a usage-based billing note ($0.02 default estimate), which is genuine cost context not present in annotations, but nothing is said about scope, database semantics, or result limits.
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 the content is an HTML-comment-wrapped billing banner rather than front-loaded task information. Brevity here reflects missing content, not conciseness.
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 for a two-parameter query tool with 0% schema coverage the description supplies nothing an agent needs to invoke it correctly – no purpose, no parameter meaning, no usage context.
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 0% for two required parameters (domain, database). With no enums and no schema docs, the description must compensate, and it says nothing about expected domain format or valid database values.
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 contains zero functional content – it is entirely a pricing banner. The only signal about what the tool does comes from the tool name itself, and there is no differentiation from siblings like get_semrush_url_organic_keywords or get_semrush_organic_competitors.
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, no alternatives named, no prerequisites. An agent has no basis for choosing this over the many other Semrush/DataForSEO keyword tools listed as siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_semrush_domain_overviewSemrush Domain OverviewDRead-onlyIdempotentInspect
Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| database | No | us |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
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 does add one genuine behavioral fact not in the annotations – a per-request price of $0.001 USD – which is useful cost context, but it discloses nothing about auth requirements, rate limits, or response 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?
It is short, but the content is boilerplate HTML-comment pricing markup that does not help an agent select or invoke the tool. Length is minimal while relevance is near zero, so it is under-specified rather than concise.
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 domain-overview tool with a required 'domain' parameter and an undocumented 'database' parameter, the description leaves the agent without the essential information needed to call it correctly. The presence of an output schema excuses explaining return values, but nothing else compensates for the missing purpose and parameter detail.
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 0% for two parameters ('domain' and 'database'), and the description supplies no meaning, format, or defaults for either. It does not compensate for the schema gap at all, and notably omits that 'database' defaults to 'us'.
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; it contains only a pricing notice wrapped in HTML comments. An agent must infer the purpose entirely from the tool name 'get_semrush_domain_overview'. It provides no verb+resource statement and no differentiation from siblings like get_semrush_domain_organic_keywords or get_semrush_domain_vs_domain.
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 exclusions, and no mention of alternatives among the many semrush/ahrefs/dataforseo siblings. The text is solely about cost, not about selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_semrush_domain_paid_keywordsDomain Paid KeywordsDRead-onlyIdempotentInspect
Usage-based billing; Default request estimate: $0.04 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| database | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
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 does add genuinely non-annotation information: a usage-based cost estimate (~$0.04/request) and a warning that final settlement may differ, which is useful behavioral context for a paid API call. It still omits rate limits, result shape, and any pagination 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 text is short and has no filler sentences, and the pricing caveat is front-loaded. However, its brevity is achieved by omitting the core purpose rather than by tight editing, so conciseness here is partly a symptom of incompleteness.
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 annotations cover the safety profile. But for a two-parameter, cost-incurring API call, the complete absence of purpose and parameter documentation leaves the definition too thin for an agent to invoke confidently.
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 0% and the description supplies no parameter information at all. 'domain' is largely self-evident, but 'database' (e.g. which regional Semrush database) is entirely undefined in both the schema and the description, leaving a required parameter ambiguous.
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 contains only a pricing/billing boilerplate block and never states what the tool does. The agent must infer the purpose entirely from the name/title 'Domain Paid Keywords', and the description does nothing to distinguish this from sibling get_semrush_domain_organic_keywords.
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 prerequisites, and no mention of alternatives. An agent cannot tell from this text why it would pick paid keywords over organic keywords (get_semrush_domain_organic_keywords) or the domain overview.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_semrush_domain_rank_historyDomain Rank HistoryDRead-onlyIdempotentInspect
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| database | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
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 only added context is usage-based billing with a ~$0.02 estimate, which is genuinely useful behavioral information beyond the annotations, but it is boilerplate and says nothing about rate limits, auth, or result shape.
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 the content is injected billing metadata in an HTML comment rather than front-loaded functional information. Brevity here reflects absence of substance rather than efficient writing.
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 everything else is missing: purpose, parameter semantics, and any routing versus the large set of sibling Semrush/DataForSEO tools. The definition is not usable on its own.
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?
Two required parameters ('domain', 'database') have 0% schema description coverage, so the schema explains neither format nor meaning. The description does not mention either parameter, leaving the agent with no guidance on valid domain syntax or which database values are accepted.
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 contains no statement of what the tool does — it is entirely a pricing boilerplate block wrapped in HTML comments. An agent must infer the purpose from the tool name alone, and gets no help distinguishing this from siblings like get_semrush_domain_overview or get_semrush_domain_vs_domain.
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, when not to, or which sibling to prefer for related Semrush domain metrics. Nothing in the text addresses selection at all.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_semrush_domain_vs_domainDomain vs DomainDRead-onlyIdempotentInspect
Usage-based billing; Default request estimate: $0.16 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| domains | Yes | ||
| database | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, covering the safety profile. The description does add one behaviorally relevant fact not available in the annotations: usage-based billing with a default per-request estimate of ~$0.16 USD, which matters for cost-aware invocation. Beyond that price disclosure it says nothing about the operation itself, so it sits at the minimum viable level.
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, but its entire content is machine-generated pricing boilerplate with HTML comment markers. It is structurally tidy yet none of it earns its place with respect to selecting or invoking the tool, so brevity here reflects omission rather than concision.
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?
Although an output schema exists (so return values need no explanation), the definition is missing everything else an agent needs: what the tool compares, how to format the two required parameters, which Semrush database to pick, and when to prefer it over siblings. For a required-parameter, non-trivial analytical endpoint this is inadequate.
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?
Both required parameters ('domains' and 'database') have 0% schema description coverage, and the description supplies no meaning for either. It never explains that 'domains' is likely a domain pair/list or what format 'database' expects (e.g. a Semrush regional database code), leaving the agent to guess at required input syntax.
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 contains no statement of what the tool does — it is entirely a pricing/billing banner. The only signal is the name and title 'Domain vs Domain', which merely restates itself without a verb, resource, or scope. An agent cannot tell from this text that it compares two domains in Semrush, nor distinguish it from get_semrush_domain_overview.
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 conditions, and no mention of alternatives. With roughly a dozen get_semrush_* siblings, an agent gets zero help deciding when domain-vs-domain comparison is the right call versus domain_overview, organic_competitors, or the DataForSEO competitors endpoints.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_semrush_organic_competitorsOrganic CompetitorsDRead-onlyIdempotentInspect
Usage-based billing; Default request estimate: $0.08 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| database | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The one genuine addition is cost disclosure (predicted ~$0.08 per request, usage-based, not fixed), which is real behavioral context an agent cannot get from annotations. However, the description says nothing about what the call returns, rate limits, or data freshness.
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, so length is not the problem; the problem is that every line is HTML-commented billing boilerplate rather than front-loaded tool purpose. Legitimate conciseness here would be a single sentence stating what the tool returns.
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?
Even granting that an output schema exists and return values need not be explained, the definition omits purpose, usage context, and the meaning of both required parameters. An agent cannot call this correctly from the description alone.
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 0% and both parameters (domain, database) are required yet completely undocumented in the schema. The description does not mention either parameter or its expected format, 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 never states what the tool does — it contains only a pricing/billing banner with no verb, resource, or scope. The title 'Organic Competitors' is the only hint, and the tool must be distinguished from many siblings like get_semrush_domain_overview and post_dataforseo_labs_google_serp_competitors_live with no help from the text.
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, when-not-to-use, or alternative-tool guidance at all. Given a large set of competing Semrush/DataForSEO competitor tools, an agent gets zero routing signal from this description.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_semrush_url_organic_keywordsURL Organic KeywordsDRead-onlyIdempotentInspect
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| database | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive and open-world, so safety is covered. The description adds only a cost estimate (~$0.02, not fixed), which is genuinely useful context for a paid third-party API, but it omits auth needs, rate limits, and result shape.
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, but every line is irrelevant boilerplate about pricing rather than tool purpose. Brevity here reflects under-specification, not conciseness.
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?
Even granting that the output schema covers return values and annotations cover safety, the description omits the one thing only it can provide: what the tool returns and how it differs from its Semrush siblings. The definition is functionally 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?
Two required parameters (url, database) with 0% schema description coverage, and the description supplies no meaning, format, or valid values for either. For a required 'database' field this is a real gap, as the agent cannot know whether it expects 'us', 'google.com', or a locale code.
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. It contains only a pricing banner, so the agent must infer purpose from the name alone, and nothing distinguishes it from sibling get_semrush_domain_organic_keywords.
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 about when to use this tool versus the many sibling alternatives (domain organic keywords, organic competitors, Ahrefs/DataForSEO equivalents). The only conditional text is about billing, not usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_categoriesBrowse the AIsa catalogueRead-onlyInspect
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 | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
post_dataforseo_labs_amazon_bulk_volume_liveAmazon Bulk Search VolumeBDestructiveInspect
This endpoint will provide you with search volume values for a maximum of 1,000 keywords in one API request. Here search volume represents the approximate number of monthly searches for a keyword on Amazon. The returned results are specific to the keywords, location, and language parameters specified in a POST request.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations carry the safety/open-world profile, so the lower bar applies. The description does add useful context beyond the schema: the 1,000-keyword cap, the meaning of the returned metric (approximate monthly Amazon searches), and the usage-based billing estimate (~$0.1356 per default request). It does not disclose rate limits, whether the endpoint is synchronous versus task-based, or the required-field behavior. Note the annotations themselves (readOnlyHint=false, destructiveHint=true) look like a generic POST default that is at odds with a pure data-lookup endpoint, but the description makes no explicit safety claim to contradict.
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 is three front-loaded sentences that state purpose, metric definition, and result scoping. However, it opens with a stray zero-width character and leading line break, and a boilerplate pricing block is appended that is not part of the tool's semantics. Functional but not 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 values need not be described. For a bulk lookup with mostly-required nested fields, the description covers what is computed and the scope, but omits the practical constraints an agent needs: that at least one location and one language identifier must be supplied, the restricted set of supported locations/languages, and the synchronous 'live' nature of the call.
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 array has 0% description coverage per the context signals, although the nested item fields (keywords, language_code/name, location_code/name, tag) are documented inside the schema. The prose only loosely maps to parameters by saying results depend on 'keywords, location, and language parameters', without explaining the code/name alternates, the required-one-of rule, or the allowed location/language pairs. This is a baseline 3: some semantic linkage, but it does not compensate for the top-level 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?
It states a concrete verb and resource: 'provide you with search volume values for a maximum of 1,000 keywords' and defines that the volume is 'the approximate number of monthly searches for a keyword on Amazon'. This is clearly distinguishable from a generic keyword tool. It stops short of explicitly differentiating itself from near siblings such as post_dataforseo_labs_amazon_related_keywords_live or google_bulk_keyword_difficulty, which is why it does not reach 5.
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 / when-not-to-use guidance and no alternatives are named, even though the sibling list contains many adjacent Amazon and Google Labs endpoints an agent must choose between. The only routing hint is implicit ('Amazon' in the name and the 1,000-keyword bulk scope), which the agent must infer on its own.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_amazon_product_competitors_liveProduct CompetitorsCDestructiveInspect
This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description clearly frames the tool as a read/report operation ('will provide you with a list', 'returned results'), yet the annotations declare readOnlyHint=false and destructiveHint=true. That is a direct conflict in the safety profile an agent relies on, which per the rules scores 1. The additional pricing note and the asin/location/language scoping are useful but do not resolve the contradiction.
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 in the first sentence, and the remaining sentences add scope and cost context with little waste. Slight deductions for the leading zero-width artifact and the padded 'will provide you with' phrasing, but it is appropriately sized.
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 described, and annotations exist, so the description is not the sole carrier of behavior. However, for a paid, many-siblinged competitor endpoint it provides no selection guidance and is out of step with the declared safety hints, leaving the definition adequate but not 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?
Top-level schema description coverage is 0% (the single 'body' wrapper is undocumented), so the description must help. It names the three key drivers — asin, location, and language — but says nothing about limit, offset, filters, order_by, or the request structure. The nested schema descriptions do carry most of the real detail, so this lands at a competent baseline.
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 resource and scope: 'a list of products that intersect with a target asin in Amazon SERPs' and that it identifies 'product competitors for any listing published on Amazon.' That is enough to distinguish it from the Apple/Google competitor siblings, though it never names or contrasts those siblings 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?
It says the data 'can help you identify product competitors' but gives no when-to-use versus alternatives, no prerequisites beyond the required asin/location/language inputs, and no exclusions. The agent is told the value of the output but not the conditions for selecting this tool over its many siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_amazon_product_kw_overlap_liveKeyword IntersectionsCDestructiveInspect
This endpoint will provide you with a list of keywords for which the target products intersect in Amazon SERP. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description frames this purely as a data-retrieval ('provide you with a list of keywords') while the annotations declare destructiveHint=true and readOnlyHint=false, so the two fields point in opposite directions and the description does nothing to reconcile them. It does add one genuinely useful behavioral fact not in the annotations (a cost estimate of $0.1356 USD), which keeps it above a flat 1, but the core write/read conflict is left unexplained.
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 short and front-loads the purpose in the first clause, with the pricing note clearly demarcated. A leading stray zero-width character and the boilerplate pricing block are blemishes, but there is no padding in the substantive sentences.
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 tool with many inputs (language/location requirements, ASIN cap, intersection_mode), the description is thin and leaves the contradictory destructive annotation unaddressed, which is exactly the information an agent needs before invoking it.
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 parameter level, so the description is expected to carry the load, yet it only notes that ASINs come in a POST request. It says nothing about limit/offset, filters, order_by, language/location mutual-exclusion, the 20-ASIN cap, or intersection_mode, all of which appear only in the structured 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?
The description names a specific verb and resource: it returns 'a list of keywords for which the target products intersect in Amazon SERP,' and ties results to the submitted ASINs. That is concrete and API-distinct. It stops short of 5 because it never distinguishes itself from close siblings such as post_dataforseo_labs_amazon_related_keywords_live or ...amazon_ranked_keywords_live.
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 prerequisites, and no mention of alternatives (e.g., related_keywords vs. this overlap endpoint). The only contextual cue is that results are scoped to the supplied ASINs, which is implied by the schema rather than offered as routing advice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_amazon_product_rank_overview_liveProduct Rank OverviewBDestructiveInspect
This endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
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 largely covered. The description adds genuinely new context by disclosing usage-based billing (~$0.1356 estimate, not fixed), which is valuable. It does not, however, reconcile the data-retrieval framing with the destructive annotation, nor mention auth or rate limits.
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 in the first clause, followed by the ASIN scoping note and a clearly demarcated pricing block. It is short and largely waste-free, marred only by a stray leading zero-width character and HTML comment 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?
An output schema exists, so return values need not be described, and cost is disclosed. However, for an endpoint in a large family of near-identical DataForSEO labs tools, the absence of any differentiation or input-requirement guidance leaves it 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?
Top-level schema description coverage is reported as 0%, but the description still identifies the key payload element — results are specific to the 'asins specified in a POST request' — and links a help article on ASINs. It adds nothing about the language/location requirements, which the nested schema documents, so it only partially compensates.
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 verb and resource: it returns ranking data from organic and paid Amazon SERPs for target products, keyed to the specified ASINs. This distinguishes it reasonably well from sibling endpoints like amazon_ranked_keywords_live or amazon_product_competitors_live, though it never explicitly names an alternative, so it stops at 4.
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 conditions or exclusions, and no routing to sibling tools such as amazon_product_competitors_live or amazon_ranked_keywords_live. The only implied usage is that you supply ASINs in a POST body.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_amazon_ranked_keywords_liveRanked KeywordsBDestructiveInspect
This endpoint will provide you with a list of keywords the target product ranks for on Amazon. The returned results are specific to the asin specified in a POST request. Learn more about ASIN in this help center article.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, openWorldHint=true, and idempotentHint=false. The description usefully adds a usage-based billing estimate ($0.1356 USD default, not fixed), which matters for a metered live endpoint. However, it does not reconcile the 'provide you with a list' framing with the destructive/non-idempotent annotations or explain that each call incurs cost.
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 focused sentences with purpose front-loaded, followed by a clearly delimited pricing block. Little waste, though the help-center pointer sentence is low value.
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 purpose plus pricing are covered. Still missing is any usage routing among the dense set of Amazon/DataForSEO siblings, and the destructive annotation is left unexplained for what reads like a query endpoint.
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 top-level 'body' parameter with 0% schema description coverage at that level, and the description adds no parameter guidance beyond implying ASIN is needed. The nested per-field schema descriptions (limit, offset, filters, location_code, ignore_synonyms) do the real work, so the description neither compensates nor misleads.
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: returns the list of keywords a target product ranks for on Amazon, scoped to a given ASIN. This is distinguishable from siblings like related_keywords or product_competitors, though the description never names those alternatives to sharpen 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 and no comparison to the many sibling Amazon endpoints (product_competitors, related_keywords, product_rank_overview). The only context is a pointer to a help-center article about ASIN, which is conceptual rather than selection guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_apple_app_competitors_liveApp Store App Competitors LiveBDestructiveInspect
This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, openWorldHint=true, destructiveHint=true, idempotentHint=false), so the description's burden is reduced. It adds genuinely useful context beyond annotations: the endpoint is live, returns competitor IDs/search volume/ranking data, and carries usage-based billing (~$0.1356 default estimate). It says nothing about rate limits, latency, or why a POST-based fetch is flagged destructive, so it is helpful but not rich.
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 sentences of purpose followed by a clearly delimited pricing block — front-loaded, no filler, and the billing caveat is correctly separated from functional text. Minor noise: a stray leading zero-width character before the first sentence.
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-value detail is unnecessary; the description still summarizes the payload (competitor IDs, search volume, ranking keywords). Combined with the richly documented body schema and existing annotations, an agent has enough to call this correctly — the only real omission (when to prefer it over sibling endpoints) is a usage-guideline gap rather than a completeness one.
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%, but the schema itself visibly documents every nested body field in detail (app_id with a URL example, mutually exclusive language/location pairs, filter/order_by syntax, limit/offset defaults). The description adds nothing about any parameter, so all param semantics come from the schema; this is a baseline case where the description neither compensates nor misleads.
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 and scope: 'a list of mobile applications that intersect with the target app for its ranking keywords on App Store,' plus what the response contains (competitor IDs, search volume, ranking data). Naming 'App Store' implicitly separates it from the Google Play sibling (post_dataforseo_labs_google_app_competitors_live), but it never distinguishes itself from post_dataforseo_labs_apple_app_intersection_live, which sounds nearly identical in purpose.
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 prerequisites, and no routing to alternatives, despite the sibling list containing three Apple App Store endpoints and a near-identical 'intersection' tool. The agent must infer the right tool 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.
post_dataforseo_labs_apple_app_intersection_liveApp Store App Intersection LiveCDestructiveInspect
This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same App Store SERP.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly frames the operation as retrieval ('provide you with a list of keywords'), yet the annotations declare destructiveHint=true and readOnlyHint=false. A read-only keyword query cannot be destructive, so the description and annotations directly conflict, which risks an agent treating a harmless query as a mutating operation.
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 authored description is a single front-loaded sentence with no filler; the purpose is stated immediately and nothing needs to be re-read.
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, the description omits important operational context (US/English-only support, the value of supplying multiple app_ids, cost implications) and leaves the annotation conflict unresolved, so it is 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 description names the app_ids object and explains its role (the apps that must rank in the same SERP), which adds semantic weight to the single top-level 'body' parameter. The nested schema itself documents limit, offset, filters, order_by, language and location in detail, so the schema carries most of the burden and 3 is an appropriate baseline.
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 verb and resource ('provide you with a list of keywords') and a precise scope ('mobile applications ... rank within the same App Store SERP'), so the intersection concept is clear. It does not, however, distinguish this from near-neighbors such as google_app_intersection_live or apple_app_competitors_live, which keeps it out of the top tier.
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-use, and no named alternative. It only implicitly signals that you must supply app_ids to get meaningful results. An agent gets no help deciding between this and the many sibling intersection/competitor endpoints.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_apple_bulk_app_metrics_liveApp Store Bulk App Metrics LiveBDestructiveInspect
This endpoint will provide you with ranking metrics for up to 1000 App Store applications.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds genuinely useful non-annotation context: usage-based billing with a ~$0.1356 estimate. However, it says nothing about auth, rate limits, or what 'live' means, and the annotations (readOnlyHint=false, destructiveHint=true) sit oddly against a description that only promises to return metrics, which an agent would reasonably read as safe.
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 in a single sentence and the pricing block is compact and clearly delimited. Little wasted text; the only filler is the auto-generated pricing comment markup.
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 return shape need not be described, and cost is covered. But 'ranking metrics' is left vague for a bulk endpoint with a structured multi-field body, and there is no guidance on the required language/location pairing that makes this call succeed.
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 'body' parameter carries no description – but the description cites the 1000-app limit, which maps to the app_ids maximum and gives the agent one concrete constraint. The nested schema documents the required language/location pairing, so the description is not the primary source for param 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?
States a specific verb+resource: it returns ranking metrics for App Store applications, with the bulk capacity (up to 1000) called out. The Apple/App Store framing implicitly separates it from the Google and Amazon siblings, but it never names those alternatives 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?
No when-to-use/when-not-to-use guidance. It does not say when to pick this over post_dataforseo_labs_google_bulk_app_metrics_live or the per-app endpoints, nor what distinguishes 'bulk metrics' from competitors/keywords endpoints. The agent must infer usage 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.
post_dataforseo_labs_apple_keywords_for_app_liveApp Store Keywords For App LiveBDestructiveInspect
This endpoint will provide you with a list of keywords for which the target app ranks on App Store. You will obtain keyword data and discover the app’s ranking position for each returned keyword.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint=true, idempotentHint=false and destructiveHint=true, covering the safety profile. The description adds genuinely useful behavioral context via the usage-based billing note ('$0.1356 USD estimate, not a fixed price'), but it says nothing about auth, rate limits, or the asynchronous/cost implications of a paid POST. It does not contradict the 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?
Two tight, front-loaded sentences plus a compact pricing block; nothing is padding. Minor deduction for the stray leading whitespace/zero-width character and for the fact that the most actionable detail (app_id requirement) is absent rather than merely brief.
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. For a paid, app-scoped endpoint the description is adequate on intent but omits the practical requirement that app_id plus language/location must be supplied, leaving that entirely to the 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?
The description contributes no parameter detail of its own; the top-level 'body' parameter has no description (0% coverage). However, the nested item schema is richly documented (app_id, language_code/name, location_code/name, limit, offset, filters, order_by), so the schema carries the burden and 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 verb and resource: it returns 'a list of keywords for which the target app ranks on App Store' plus ranking position per keyword. This clearly distinguishes it from siblings like post_dataforseo_labs_apple_app_competitors_live and post_dataforseo_labs_google_keywords_for_app_live without the agent needing to open 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?
The description explains what the endpoint returns but gives no guidance on when to choose it over alternatives such as post_dataforseo_labs_apple_app_competitors_live or the Google equivalents. There are no stated prerequisites, no exclusions, and no mention of the fact that app_id and a language/location pair are effectively mandatory.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_app_competitors_liveGoogle Play App Competitors LiveBDestructiveInspect
This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on Google Play. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=true, openWorldHint=true), so the description need not repeat it. What it does add beyond annotations is the billing model and a per-request cost estimate (~$0.1356 USD, usage-based, non-fixed) – genuine behavioral context an agent needs before calling a metered endpoint. It still says nothing about auth, latency, or that this is a live (non-task) endpoint versus the batched siblings.
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 sentences are front-loaded with the resource and the returned data, and the pricing block is clearly delimited boilerplate that adds real cost information. Slightly padded by the HTML-comment wrapper, but no sentence is 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 values need no explanation in prose. However, for a metered single-param POST tool the description omits the operationally critical constraints (required app_id, US/English-only support, 1000-app limit) that a caller must know before invoking, forcing the agent into the nested schema to discover them.
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 as 0% and the single top-level `body` parameter is entirely undescribed, so the description carries the burden of explaining parameters – yet it mentions none. It does not tell the agent that `app_id` is required, that `language_name`/`language_code` and `location_name`/`location_code` are mandatory pairs, or that only English + US (2840) are currently supported.
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 specific verb+resource (list of mobile apps that intersect with the target app for its ranking keywords on Google Play) and states the return payload (competitor app IDs with search volume and ranking data). It implicitly distinguishes itself from sibling post_dataforseo_labs_google_app_intersection_live and post_dataforseo_labs_apple_app_competitors_live by naming Google Play + competitors, but it never explicitly routes between them.
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/when-not guidance and no alternative tool is named, despite several near-identical siblings (apple_app_competitors_live, amazon_product_competitors_live, google_app_intersection_live). The agent is left to infer selection purely from the tool name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_app_intersection_liveGoogle Play App Intersection LiveCDestructiveInspect
This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same Google Play SERP.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already carry the behavioral profile (readOnlyHint=false, destructiveHint=true, idempotentHint=false, openWorldHint=true), but the description adds nothing on top: no note that this is a billed live call, no rate-limit or auth context, and the only extra text is a templated auto-injected pricing block. The sentence about returned keywords largely duplicates what the output schema already provides.
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 substantive description is a single front-loaded sentence with no padding (aside from a stray leading zero-width character). The remaining text is a clearly delimited, machine-injected pricing note rather than the author's prose. Size is appropriate for a one-parameter endpoint.
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 rich nested schema descriptions cover most field-level detail. However, the description omits for a complex keyword-lab endpoint the de facto required inputs (app_ids, language, location) and the English/US-only restriction, leaving the agent to discover these only by reading the 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?
The description references 'the app_ids object' by name, giving minimal linkage to the key input, but says nothing about limit/offset, filters, order_by, or the effective language/location constraints (English- and US-only). With schema description coverage reported at 0% for the top-level body parameter, the description does not compensate for the 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 names a specific verb and resource: it 'will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same Google Play SERP.' The 'intersection' concept (keywords where multiple apps co-rank) is conveyed clearly enough to separate it from keywords_for_app-style siblings. It stops short of explicitly naming the sibling it should be preferred over, so 4 rather than 5.
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 choose this endpoint versus alternatives like post_dataforseo_labs_google_keywords_for_app_live or post_dataforseo_labs_google_app_competitors_live, nor any stated prerequisites. The agent must infer selection purely from the one-line purpose statement.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_bulk_app_metrics_liveGoogle Play Bulk App Metrics LiveCDestructiveInspect
This endpoint will provide you with ranking metrics for up to 1000 Google Play applications.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description characterizes the endpoint as one that 'will provide you with ranking metrics' (a retrieval operation), while the annotations declare readOnlyHint=false and destructiveHint=true for the same call - an inconsistent behavioral signal an agent could misread. On the positive side, it does disclose usage-based billing with a concrete cost estimate, which is genuine behavioral context not present 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?
A single front-loaded sentence stating scope and batch limit, plus a compact boilerplate pricing note. Nothing is padded or buried, though the pricing block is standardized filler rather than task-relevant instruction.
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 detail is not required, and the input schema covers the fields. What is missing is any routing context against ~40 sibling lab endpoints and any note of the endpoint's practical constraints (US-only location, English-only language), which the schema states but the description never reinforces.
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 shown top-level schema coverage is 0%, but the nested body schema documents every field (app_ids with URL/ID example and 1000 cap, language_code/name, location_code/name, tag) in detail, so parameters are well specified elsewhere. The description's only contribution is the 'up to 1000' batch limit, which merely echoes the schema's own app_ids maximum.
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 (Google Play applications) and what the tool returns (ranking metrics) at a stated batch size (up to 1000). An agent can distinguish it from keyword-focused siblings like google_keywords_for_app_live, but it never explicitly names or contrasts a 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 guidance on when to choose this tool over the many adjacent Google/Apple app endpoints (app_competitors, app_intersection, keywords_for_app, apple_bulk_app_metrics), nor any prerequisite or exclusion. The only context provided is a billing estimate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_bulk_keyword_difficulty_liveBulk Keyword DifficultyCDestructiveInspect
This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100.
Usage-based billing; Default request estimate: $0.0734 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=false and destructiveHint=true, yet the description's 'provide you with the Keyword Difficulty metric' describes a pure read/retrieval operation, so the two conflict. The description does add a useful behavioral detail — usage-based billing with a default estimate of $0.0734 — but it never addresses auth, rate limits, or the destructive classification, so transparency is weak and partly contradictory.
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 front-loaded with the core purpose and reasonably short, but the second and third sentences overlap heavily (both explain ranking in top-10 organic results), and the boilerplate billing block adds bulk without adding task-selection value.
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 unnecessary, but the description leaves the single array parameter and its required nested fields entirely uncovered and provides no usage routing. For a bulk live endpoint whose only param is a structured array, this is 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?
Reported schema description coverage is 0% at the top level (the 'body' array itself is undocumented), so the description carries the burden of explaining parameters — and it mentions none of them. It doesn't explain the required keywords array, the max-1000 limit within the array, or the language/location code requirements.
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 specific resource (Keyword Difficulty metric) and a clear scope (bulk, up to 1,000 keywords in one request), and it even defines what the metric means. It does not, however, distinguish this bulk endpoint from siblings like get_semrush_keyword_difficulty or post_dataforseo_labs_google_keyword_overview_live.
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 the 1,000-keyword bulk limit, which implies when the endpoint is appropriate, but gives no explicit when-to-use/when-not-to-use guidance and names no alternative sibling for single-keyword or cross-source lookups. An agent must infer the routing decision on its own.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_bulk_traffic_estimation_liveBulk Traffic EstimationBDestructiveInspect
This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the mutation/safety profile (destructiveHint=true, readOnlyHint=false), and the description does not contradict this. It adds genuinely useful behavior context the annotations lack: the usage-based billing model with a $0.1356 default estimate and the 1,000-target cap. It does not disclose return shape, but an output schema exists to cover that.
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 tight sentences front-load the core capability before the boilerplate pricing comment block. The pricing annotation is templated but the descriptive text itself wastes no words and is appropriately sized.
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 live, high-amplitude bulk endpoint with an output schema, the description covers capability, target limits, and cost but omits routing guidance and any parameter-level detail. It is adequate to identify the tool, not to invoke it optimally.
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% for the single top-level body parameter, so the description carries the burden of explaining parameters and largely fails to. It mentions the 1,000-target limit but says nothing about item_types, language/location codes, or other fields an agent must populate, adding little beyond the raw 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?
The description states a specific verb and resource ('provide you with estimated monthly traffic volumes') and identifies the scope ('up to 1,000 domains, subdomains, or webpages'), which cleanly distinguishes it from keyword-oriented Labs siblings. It stops short of naming the closest sibling (e.g., domain_rank_overview) or contrasting its bulk nature against single-target tools.
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 conditions for selecting this over alternatives, and no exclusions. The 'up to 1,000 targets' note is a scope limit, not routing guidance, leaving the agent to infer usage 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.
post_dataforseo_labs_google_categories_for_domain_liveCategories For DomainBDestructiveInspect
This endpoint will provide you with Google product or service categories that include keywords the domain ranks for in search. Furthermore, you will obtain general rankings and traffic data for the keywords under a certain category.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint=true, idempotentHint=false and destructiveHint=true, so the safety profile is partly covered structurally. The description adds one genuine behavioral trait beyond them — the usage-based billing note with a ~$0.1356 default request estimate — but it never explains why the call is flagged destructive, does not mention that enabling clickstream data doubles the price, and gives no auth or rate-limit 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?
Two tight, front-loaded sentences that describe the resource and the returned metrics without padding. The appended pricing block is boilerplate rather than author-written prose, but it does not bloat the core statement.
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 is not obliged to explain return values, and annotations carry the safety profile. However, for a 12-plus-field body with mandatory location/language and target semantics, the description omits the call prerequisites and the sibling differentiation an agent needs, leaving the schema to carry that burden alone.
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 parameter (body) has no description in either the description text or the schema, and the reported schema coverage is 0%. The description contributes no parameter meaning whatsoever; all real semantics (target, location, language, filters, limit/offset) live only in the nested schema, which the description never references or clarifies.
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: it returns Google product/service categories containing keywords the domain ranks for, plus rankings and traffic data for those keywords. That is concrete enough to act on, but it never differentiates itself from the near-identical siblings post_dataforseo_labs_google_categories_for_kw_live and post_dataforseo_labs_google_keywords_for_categories_live, so an agent must guess which category endpoint to pick.
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, when-not-to-use, or alternative-tool guidance at all. It never mentions that target is required, that location and language (code or name) must be supplied, or when this endpoint should be preferred over the keyword-category or domain-rank-overview siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_categories_for_kw_liveCategories for KeywordsBDestructiveInspect
This endpoint will provide you with Google product and service categories related for each specified keyword. You can indicate a maximum of 1,000 keywords in one API request.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorld and non-idempotent, but the destructiveHint=true / readOnlyHint=false pair is counterintuitive for an endpoint whose description says it merely 'provides' category data; the description never explains that the flag reflects usage-based billing rather than data mutation. It does add genuinely useful behavior the annotations lack: the 1,000-keyword request cap and a default cost estimate of $0.1356 USD. That pricing disclosure is real added value, but the destructive framing is left unexplained.
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 front-loaded and the limit sentence is short and useful. The embedded pricing comment block adds a third section of boilerplate, but it is clearly delimited and only minimally interrupts the two substantive sentences.
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, and the pricing note covers the cost dimension. However, for a paid live endpoint the description omits the prerequisites (language selection) and any positioning against the several sibling keyword-category tools, leaving the destructive annotation unexplained despite it being the most surprising signal.
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% for the top-level body parameter, so the description carries the burden and largely fails it. The only parameter fact offered, the 1,000-keyword maximum, is already stated in the nested keywords description, and nothing is said about the tag field, language_code/language_name alternatives, or the required-inside-item quirk that the empty top-level required array obscures.
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 verb and resource: it returns Google product and service categories for each specified keyword. An agent can distinguish this from the nearby post_dataforseo_labs_google_categories_for_domain_live and post_dataforseo_labs_google_keywords_for_categories_live, since the input unit (keywords) is named. It stops short of explicitly routing against those siblings, so it is clear but not differentiated.
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 named alternative, and no prerequisite stated (the schema requires language_code or language_name on each body item, and keywords itself is marked required inside the item, while top-level required is empty). The only usage-relevant fact given is the 1,000-keyword ceiling, which is also present in the schema. An agent gets no help deciding between this and the many other keyword/category endpoints.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_domain_rank_overview_liveDomain Rank OverviewCDestructiveInspect
This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results.
Usage-based billing; Default request estimate: $0.0121 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description frames the endpoint purely as informational retrieval ('provide you with ranking and traffic data', 'you will be able to review'), which reads as a read-only query. The annotations declare readOnlyHint=false and destructiveHint=true, directly conflicting with that framing. The pricing/billing disclosure is a genuinely useful addition, but the core behavioral claim is inconsistent with the structured metadata.
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 tight sentences front-load what the tool returns, followed by a clearly demarcated billing note. Apart from a stray leading zero-width character, nothing is wasted, although the pricing block is verbosity imposed by the platform rather than the author.
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 describe return values, and it correctly focuses on inputs and output scope. However, for a live paid endpoint with a single nested array parameter and no usage guidance, it omits the required target format and any indication of when this overview is preferable to the other labs endpoints, leaving the definition at minimum viability.
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 single 'body' array property has no description), so the description must compensate for parameter meaning, and it does not: 'target', 'limit', 'offset', 'language_code/name' and 'location_code/name' are never referenced or explained. The nested item-level schema does document them well, which partially rescues usability, but the description itself adds no parameter 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 concrete resource and verb: ranking and traffic data from organic and paid search for a specified domain, including SERP ranking distribution and estimated monthly traffic. This is materially more specific than the title alone. It stops short of distinguishing the tool from close siblings such as google_historical_rank_live or google_subdomains_live, which return similarly framed domain-level metrics.
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 choose this tool over the many sibling domain/keyword endpoints, and no mention that the target domain must be bare (no https:// or www.), which is a practical prerequisite for a successful call. Usage is left entirely to inference from the name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_historical_bulk_traffic_liveHistorical Bulk Traffic EstimationADestructiveInspect
This endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. If you do not specify the range, data will be returned for the previous 12 months. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=true, openWorldHint=true, idempotentHint=false), so the description's main added value is the cost disclosure: usage-based billing with a default request estimate of $0.1356 USD and a note that account-specific pricing may differ. That is genuinely useful pre-invocation context analogous to a rate/cost limit, and the description also flags the historical data coverage boundary (through October 2020). It does not explain the state-changing implication of the destructive annotation, so it is short of 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 capability, then defaults, then output breakdown, then pricing. Every sentence is informative and there is no padding, though the boilerplate pricing block is slightly bulky relative to the rest.
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. The description covers purpose, scope limits, default behavior, data availability boundary, output categories, and cost. The main remaining gap is routing guidance against the closely named non-historical 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?
Reported schema description coverage is 0%, so the description must carry weight, and it does add some: the 1,000-domain cap, the 12-month default range, and the available item types. But it omits several meaningful parameters (language_code/language_name, location_code/location_name, tag, ignore_synonyms), so it only partially compensates 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 a specific verb and resource: historical monthly traffic volumes for up to 1,000 domains over a specified time range, with a per-item-type breakdown (organic, paid, featured snippet, local pack). The word 'historical' plus the date-range semantics implicitly separate it from the non-historical sibling post_dataforseo_labs_google_bulk_traffic_estimation_live, but that sibling is never named, so the differentiation is inferential rather than explicit.
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 explains the default behavior clearly ('If you do not specify the range, data will be returned for the previous 12 months') and the data floor (October 2020), which tells the agent when the tool is applicable. However, it gives no explicit guidance on when to prefer this over the current-snapshot sibling bulk_traffic_estimation endpoint, nor any exclusions or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_historical_keyword_data_liveHistorical Keyword DataBDestructiveInspect
This endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. You can get historical keyword data since August, 2021, depending on keywords along with location and language combination. You can find the list of supported locations and languages here.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=true, openWorldHint=true), so the bar is lower. The description adds genuinely useful context beyond the schema: historical coverage start (August 2021) and a usage-based billing estimate ($0.1356 default). It does not reconcile the destructive/readOnly annotations with what is plainly a data-retrieval endpoint, nor mention auth or rate limits.
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 in the first sentence and the whole body is short. The pricing block earns its place as cost context, though the leading zero-width characters before the first sentence are 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?
An output schema exists, so return values need not be explained, and the annotations cover behavior. The description covers data meaning, historical range, and cost, but omits the batch/array request mechanics and the relationship to the near-identical non-historical siblings, leaving selection ambiguity.
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 at 0% (the single 'body' property is undocumented), but the nested item properties carry very rich descriptions. The description compensates partially by naming keywords, location, and language, matching the request fields, though it says nothing about the array/body wrapper or the 700-keyword / 80-character limits.
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 specific verb and resource ('provides Google historical keyword data for specified keywords') and enumerates the returned metrics (search volume, CPC, paid-competition values, monthly searches, trends), so an agent knows exactly what it gets. The 'historical' qualifier implicitly distinguishes it from the non-historical sibling post_dataforseo_labs_google_keyword_overview_live, but no sibling is named 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?
It states data coverage (since August 2021) and that availability varies by keyword/location/language, but never says when to pick this tool over alternatives such as post_dataforseo_labs_google_keyword_overview_live or post_dataforseo_keywords_trends_explore_live. No when-not guidance or prerequisite conditions are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_historical_rank_liveHistorical Rank OverviewBDestructiveInspect
This endpoint will provide you with historical data on rankings and traffic of the specified domain, such as domain ranking distribution in SERPs and estimated monthly traffic volume for both organic and paid results.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations (readOnlyHint=false, destructiveHint=true, idempotentHint=false, openWorldHint=true) already carry the safety profile, so the description is not the main burden carrier. It does add real value by disclosing usage-based billing with a default estimate of ~$0.1356 USD, which is behavioral context an agent cannot get from annotations or schema. It does not reconcile the destructive hint against what reads like a pure data-retrieval endpoint, which is a notable unexplained tension.
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 is front-loaded in a single well-formed sentence, followed only by a bounded pricing note. Nothing is padded or redundant. The stray leading whitespace/zero-width character is sloppy but not materially harmful.
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 cost disclosure is a plus. What is missing is the operational context an agent needs to invoke it correctly: that a target domain is effectively required, that location/language must be supplied in one of two forms, and how this differs from the sibling rank-overview tool. Adequate but with clear gaps.
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% for the top-level parameter, and the description contributes no parameter meaning at all: it never mentions target, date_from/date_to, location, or language requirements. The nested item schema does document these fields in detail, which prevents a 1, but the description itself does nothing 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 names a clear resource and scope: historical rankings and traffic for a specified domain, spelled out as SERP ranking distribution plus estimated monthly organic and paid traffic. That is specific enough that an agent knows what it returns. It never distinguishes itself from the closest sibling, post_dataforseo_labs_google_domain_rank_overview_live (current vs. historical), so it stops short of a 5.
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 prerequisites such as the required target domain or the location/language pair, and no routing advice among the many sibling Labs endpoints. The only usage-adjacent content is the billing footer, which addresses cost, not selection. Nothing is misleading, but the agent gets no help choosing this over the non-historical rank overview.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_keyword_ideas_liveKeyword IdeasBDestructiveInspect
The Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array.
Usage-based billing; Default request estimate: $0.132 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint, non-idempotent, and destructive/readOnly=false, so the safety profile is largely covered by structured data and nothing here contradicts it. The description adds genuinely useful cost transparency via the usage-based billing note ($0.132 default estimate), but omits other material behaviors such as the required location/language pairing and the double-charge when include_clickstream_data is enabled.
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 substantive sentences plus a pricing block, front-loaded with the core purpose and free of filler. The pricing banner is boilerplate but short and informative; the leading stray character is a minor formatting blemish.
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, and the pricing note covers cost. Still missing for an agent to use it confidently are differentiation from the sibling keyword endpoints and confirmation of the location/language requirement, which the schema forces but the description never signals.
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?
Only one top-level parameter (body) exists, and the schema's nested property descriptions are extremely detailed, so the schema carries the parameter burden. The description adds just one hint ('seed keywords specified in a POST array'), which does not compensate for the reported 0% coverage at the top level nor mention the required keywords/location fields.
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 verb and resource: it generates search terms ('keyword ideas') relevant to the categories of the seed keywords supplied. It explains the selection algorithm (same-category matching), which separates it conceptually from siblings. However, it never names or contrasts with the very similar siblings (post_dataforseo_labs_google_keyword_suggestions_live, post_dataforseo_labs_google_related_keywords_live), so an agent must infer the difference.
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 / when-not-to-use guidance and no mention of alternatives, despite a crowded sibling set of near-identical keyword-expansion endpoints. The description only says what the endpoint does, leaving the agent to guess which of the several keyword endpoints to select.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_keyword_overview_liveKeyword OverviewBDestructiveInspect
This endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches, as well as SERP and backlink information. Additionally, you can obtain clickstream data, such as clickstream search volume, by specifying the include_clickstream_data parameter.
Usage-based billing; Default request estimate: $0.0254 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=false, destructiveHint=true, and idempotentHint=false, yet the description neither explains that destructive framing nor notes auth/permission needs. It does add genuinely useful context not in the annotations: the ~$0.0254 default cost estimate and the doubling of price when include_clickstream_data is enabled.
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 front-loaded sentences that lead with what data is returned, plus a clearly delimited pricing boilerplate block. No wasted prose, though the boilerplate is not the description's core job.
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 detail is not required, and the tool is a single-parameter live query. However, the description omits the input constraint pairs the schema enforces (language_code/language_name and location_code/location_name are each required in some combination), which an agent needs to call it successfully.
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 recommended parameter 'body' has no description of its own (0% coverage per the signals), and the description adds only the include_clickstream_data behavior. The nested oneOf schema is in fact well documented, so the description neither compensates for nor detracts from the schema; a baseline 3 fits.
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 ('provides') and resource ('Google keyword data for specified keywords') and enumerates the returned metrics (CPC, competition, search volume, search intent, monthly searches, SERP/backlink info). Clear enough to call, but it never distinguishes itself from sibling keyword tools such as keyword_ideas, keyword_suggestions, or google_search_intent.
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, no prerequisites, and no routing against the many sibling keyword endpoints. The only conditional hint is that clickstream data can be obtained by setting include_clickstream_data, which is a parameter note rather than usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_keywords_for_app_liveGoogle Play Keywords For App LiveCDestructiveInspect
This endpoint will provide you with a list of keywords for which the target app ranks on Google Play. You will obtain keyword data and discover the app’s ranking position for each returned keyword.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds a genuinely useful billing note (usage-based, ~$0.1356 per request), which annotations do not convey. However, it describes a pure retrieval ('provide you with a list', 'obtain keyword data') while annotations declare readOnlyHint=false and destructiveHint=true — a material mismatch that could confuse an agent about the tool's safety profile. It also omits any rate-limit or per-call cost implications beyond the estimate.
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 direct sentences led by the purpose, followed by a compact pricing block — appropriately sized with no filler. Minor blemishes: a stray zero-width character at the start and HTML comment markers around the pricing note.
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 detail is unnecessary. The description covers what the endpoint does and its cost, but for an endpoint with a required app_id, required language/location pairing, and filter/sort capabilities, it leaves an agent under-informed about 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% and the description adds no parameter meaning whatsoever: it never mentions the required app_id, the limit/offset paging controls, the filters/order_by arrays, or the language/location requirement. With such low coverage the description should compensate, but it does 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 a specific resource and outcome: keywords the target app ranks for on Google Play, plus ranking position per keyword. The 'Google Play' qualifier usefully separates it from the sibling post_dataforseo_labs_apple_keywords_for_app_live, though it does not distinguish it from other Google Labs endpoints (e.g., google_app_competitors_live).
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 prerequisites (a valid Google Play app_id, the required language/location pair), and no routing to alternatives such as post_dataforseo_labs_google_app_competitors_live. The agent must infer usage entirely from the name and schema.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_keywords_for_categories_liveKeywords For CategoriesBDestructiveInspect
This endpoint will provide you with a list of keywords relevant to the specified product categories. You will get the search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values for each keyword.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, openWorldHint=true and idempotentHint=false, so the safety profile is covered structurally. The description adds useful behavioral context by disclosing billing (default estimate $0.1356, usage-based, not fixed), which matters for a paid live call; it says nothing about auth, rate limits, or pagination limits beyond what the schema carries.
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 in a single compact sentence followed by the returned-metric list, with no filler. Minor detraction from a stray zero-width character at the start and a pricing block that reads as injected boilerplate rather than authored 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 return values need not be re-explained (the description does so anyway, mildly redundantly). For a schema this complex — one nested body object with fifteen properties and implicit required-field rules — the description is thin, leaving the agent to discover the category/language/location requirements only inside the 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?
Top-level schema description coverage is 0% and the description never discusses the body payload. The phrase 'specified product categories' loosely maps to category_codes, but the required language/language_code and location/location_code pairing, pagination via offset_token, and the filter semantics are left entirely to 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?
The description states a specific verb and resource: it returns keywords relevant to specified product categories, and enumerates the metrics returned (search volume, 12-month trend, CPC, competition). That is enough to separate it from siblings like keywords_for_app, categories_for_kw, or keyword_ideas, though no sibling is named 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?
There is no when-to-use or when-not-to-use guidance, no mention of alternatives (e.g. keyword_ideas, related_keywords), and no prerequisites such as the language/location pairing or the 20-category cap required by the body. The agent must infer all of this from the sibling list and schema.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_keyword_suggestions_liveKeyword SuggestionsBDestructiveInspect
The Keyword Suggestions endpoint provides search queries that include the specified seed keyword.
Usage-based billing; Default request estimate: $0.132 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=true, idempotentHint=false, openWorldHint=true), so the description's main added value is the usage-based billing estimate ($0.132 default), which is genuinely useful behavioral context for a paid API call. It does not explain why the tool is flagged destructive, nor does it repeat or contradict that flag, so it neither contradicts nor enriches the annotation set further.
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 in a single tight sentence, followed by a clearly delimited pricing block. Nothing is wasted, though the brevity edges toward under-specification given the tool's numerous siblings.
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, and annotations cover the safety profile. What is missing is selection context: for a keyword-research endpoint sitting among roughly ten near-neighbor DataForSEO Labs tools, the agent gets no signal on when this one is preferred.
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 description adds nothing about parameters, but the reported 0% coverage reflects only the top-level 'body' property; the nested request fields (keyword, location_code, filters, order_by, include_clickstream_data, etc.) are documented in extensive detail inside the schema itself. Since the schema already carries the parameter semantics, the description adding nothing lands at the baseline rather than a penalty.
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 specific deliverable ('search queries that include the specified seed keyword'), which is a real verb+resource and even disambiguates it semantically from related-keyword tools. It never names a sibling tool, however, so the agent must infer the boundary with tools like post_dataforseo_labs_google_related_keywords_live or post_dataforseo_labs_google_keyword_ideas_live on its own.
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 statement, no when-not-to-use statement, and no mention of any alternative among the many keyword-research siblings. The only usage signal is implied by the name and the one-line definition.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_kw_for_site_liveKeywords For SiteCDestructiveInspect
The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain, subdomain, or webpage. Each keyword is supplied with relevant categories, search volume data for the last month, cost-per-click, competition, and search volume trend values for the past 12 months.
Usage-based billing; Default request estimate: $0.132 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
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 safety profile is carried by structured data. The description adds genuinely useful context the annotations do not: usage-based billing with a ~$0.132 default estimate. It says nothing, though, about the destructive/non-idempotent claims or about the double-price clickstream option, and there is a mild tension between the retrieval framing and 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?
The purpose sentence is front-loaded and the second sentence is not wasteful, but nearly half the text is spent enumerating return fields that an output schema already covers. The pricing block is a template artifact rendered as plain text rather than integrated 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?
For a tool with a large nested body (target, location/language, filters, sorting, pagination, cost-incurring options) the description covers only the purpose and the response fields, and those fields are already defined by the output schema. Missing are any parameter usage notes, prerequisites, or the behavior implied by the destructive/non-idempotent annotations.
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 input is 0%, so the description is expected to compensate but does not. It vaguely implies the 'target' concept (domain/subdomain/webpage) but never mentions location, language, limit/offset, offset_token, filters, order_by, or any of the other inputs; the fields it does enumerate (volume, CPC, competition, trend) are output fields, not parameters.
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 returns "a list of keywords relevant to the target domain, subdomain, or webpage." That clearly distinguishes it from a status or schema tool. However it never contrasts itself with the many closely-named siblings (keyword_ideas, keyword_suggestions, related_keywords, keyword_overview), so an agent cannot tell which keyword source to pick from the text 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?
There is no guidance on when to use this endpoint versus the other Labs keyword endpoints, and no prerequisites (target, location, language) are stated. The description only says what data comes back, leaving the selection decision entirely to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_relevant_pages_liveRelevant PagesDDestructiveInspect
Usage-based billing; Default request estimate: $0.015 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint=true, destructiveHint=true, non-idempotent, non-readOnly, so safety is covered structurally. The description's only added value is a billing estimate ($0.015 default, not fixed, account-specific), which is genuinely useful cost context. Beyond that it discloses nothing about what the call does, its latency, or what data it returns.
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 the content is boilerplate billing HTML-comment scaffolding plus a stray zero-width character. Brevity here reflects missing content rather than efficient editing, so it cannot earn a conciseness credit.
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 described, but for a paid, open-world DataForSEO Labs endpoint with a rich filter/target body, the description omits purpose, usage, and parameter semantics entirely. It is nowhere near complete enough for an agent to invoke 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?
The tool has one parameter ('body') with a reported 0% schema description coverage at the top level. The description contributes zero information about parameters, targets, filters, or the required 'target' domain field, leaving the agent to reverse-engineer everything from the nested schema alone.
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 contains no statement of what the tool does at all — it is a pricing note (
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 whatsoever on when to use this tool versus the many sibling labs endpoints (e.g. google_domain_rank_overview, google_serp_competitors, google_subdomains). Usage must be inferred entirely from the tool name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_search_intent_liveSearch IntentBDestructiveInspect
This endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword’s search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability.
Usage-based billing; Default request estimate: $0.0073 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=false, destructiveHint=true, idempotentHint=false and openWorldHint=true, so the safety profile is already carried structurally. The description adds genuinely decision-relevant context beyond that: per-request usage-based cost (~$0.0073) and variable account pricing, which matters for a billed live call. It does not, however, explain the non-idempotent/destructive annotation, leaving a mild unexplained tension with the 'provide you with data' framing.
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 tight sentence covering the operation, the per-keyword granularity, and the result shape, followed by a pricing block. There is a stray leading whitespace character and the billing banner is boilerplate, but the core content is front-loaded and waste is minimal.
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 does state the input ceiling and cost. What remains missing for a live, paid, non-idempotent endpoint is any routing guidance against the many sibling keyword endpoints and any note on batching or latency behavior.
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 is undocumented), but the nested properties for 'keywords' and 'tag' carry rich descriptions, and the description restates the meaningful constraint that up to 1,000 keywords are accepted. It adds little else — requiredness, lowercasing, and encoding come only from the schema. Baseline 3 given one parameter with schema-side detail.
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 verb and resource: obtain search intent data (intent + probability, plus secondary intents) for up to 1,000 keywords. This is distinguishable from sibling Labs endpoints like keyword_overview or keyword_ideas by subject matter, though the description never names or contrasts itself against those alternatives.
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 statement of when search-intent classification is the right choice versus keyword_volume, keyword_suggestions, or the AI keyword tools in the sibling list. The only usage-adjacent information is the 1,000-keyword input cap, which is a limit rather than a selection criterion.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_serp_competitors_liveSERP CompetitorsCDestructiveInspect
This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords.
Usage-based billing; Default request estimate: $0.0192 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description frames this purely as a data-retrieval call ('will provide you with a list of domains'), yet the annotations declare readOnlyHint=false and destructiveHint=true. A reader who trusts the description would not expect a destructive operation, producing an inconsistent behavioral picture. The only genuine value-add is the pricing note ($0.0192 default estimate, usage-based billing), which is useful but does not resolve the read/write mismatch.
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 substantive sentences, front-loaded with the endpoint's purpose and output metrics, followed by a clearly demarcated pricing block. It is well sized with little waste; the stray zero-width character and the HTML-comment wrapper are minor noise but do not impede comprehension.
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. However, this endpoint's real complexity lives in the body object's fields (required language/location pair, keyword rules and limits, filter/order_by syntax), none of which the description addresses. For a payload with that many conditional requirements, the description leaves an agent under-informed.
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% for the single top-level 'body' parameter, and the wrapper is an opaque array of objects that the description never explains. The description only echoes that keywords are the input, adding no syntax, format, or requirement detail (e.g., language/location pair requirement, 200-keyword cap, filter/order_by structure) beyond what the schema itself says.
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: it returns 'a list of domains ranking for the keywords you specify,' along with the metrics (SERP rankings, rating, estimated traffic, visibility) those domains gain. That is a clear, self-contained statement of what a SERP-competitors endpoint does. It never names or contrasts itself against siblings like get_semrush_organic_competitors or post_dataforseo_backlinks_competitors_live, so it stops short of a 5.
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, when-not-to-use, or alternative-tool guidance anywhere in the description. With several near-neighbor competitor tools in the sibling list (SEMrush organic competitors, DataForSEO backlinks competitors), an agent has no signal to route between them.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_subdomains_liveSubdomainsBDestructiveInspect
This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare openWorldHint, destructiveHint=true, readOnlyHint=false and non-idempotence, so the safety profile is largely carried by structured data. The description adds genuinely useful behavioral context by disclosing usage-based billing and a $0.1356 default estimate, which explains the cost aspect. It does not cover auth requirements, rate limits, or why the annotation marks 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?
Two focused sentences front-load the purpose and output before the injected pricing block. Every sentence earns its place, though the boilerplate pricing marker is not part of the tool's own authoring.
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, and annotations cover safety. However, for the sole input parameter the description offers no formatting guidance, and it omits any when-to-use context against the crowded domain-oriented sibling set, leaving noticeable gaps.
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 as 0% at the top level (the single 'body' parameter is undocumented), so the description should compensate. It only implies a domain target via 'the specified domain' and gives no format guidance (e.g. no https:// or www. prefix), leaving the required 'target' field to the nested 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: 'provide you with a list of subdomains of the specified domain' plus the ranking and traffic distribution returned. The scope is distinct from most siblings, though it never names a sibling to contrast against (e.g. domain_rank_overview or relevant_pages), so differentiation is implicit rather than explicit.
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 statement of when to use this endpoint versus alternatives. With many sibling Labs endpoints that also take a domain (domain_rank_overview, relevant_pages, serp_competitors), the agent gets no signal about which domain-oriented tool fits which question. Usage context is only loosely implied by the output described.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_labs_google_top_searches_liveTop SearchesCDestructiveInspect
The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics, product categories, and Google SERP data.
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=true, openWorldHint=true), so the description's lower burden is met partly by the added pricing context ('Default request estimate: $0.1356 USD', not a fixed price). It does not explain why the operation is flagged destructive, whether the request is billed/rate-limited beyond the estimate, or what happens on failure. Given annotation coverage, a 3 is appropriate.
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 note; front-loaded with the endpoint identity and reasonably free of waste. The pricing block is boilerplate but compact.
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 annotations cover safety. But for a complex, paid, location-scoped keyword API the description omits what the tool conceptually returns and any usage context, leaving gaps an agent would need to close from the schema alone.
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% for the top-level 'body' parameter, so the description carries the burden of compensating and does not. It says nothing about the location/language requirement, filters, limit/offset, or the offset_token pagination behavior. The rich nested schema descriptions help, but the description itself adds no parameter meaning.
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 endpoint and says it returns keywords from the DataForSEO Keyword Database with Google Ads metrics, product categories, and SERP data. However, it never explains what 'Top Searches' actually means functionally (most popular searches for a location/language) and offers no differentiation from the many sibling keyword tools such as google_keyword_ideas_live or google_related_keywords_live. The purpose is implied but marketing-flavored rather than precise.
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 prerequisites, and no mention of alternatives among the dozens of sibling DataForSEO Labs endpoints. The agent is left to infer entirely from the name and the mass of siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
searchSearch AIsa tools and agent-ready plansARead-onlyInspect
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. |
Output Schema
| 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 |
TDQS
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.
useRun an AIsa operationCDestructiveInspect
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 |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
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.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
35 tool updates
- Added
account - Removed
get_details - Changed
post_dataforseo_labs_amazon_bulk_volume_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keywords": [ - "buy laptop", - "cheap laptops for sale", - "purchase laptop" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><a name=\"loc\"></a><br><strong>Note:</strong> this endpoint currently supports the following locations and languages only:<p><code>Australia</code> - <code>2036</code>, <code>en</code><br><code>Austria</code> - <code>2040</code>, <code>de</code><br><code>Canada</code> - <code>2124</code>, <code>en</code><br><code>Egypt</code> - <code>2818</code>, <code>ar</code><br><code>France</code> - <code>2250</code>, <code>fr</code><br><code>Germany</code> - <code>2276</code>, <code>de</code><br><code>India</code> - <code>2356</code>, <code>en</code><br><code>Italy</code> - <code>2380</code>, <code>it</code><br><code>Mexico</code> - <code>2484</code>, <code>es</code><br><code>Netherlands</code> - <code>2528</code>, <code>nl</code><br><code>Saudi Arabia</code> - <code>2682</code>, <code>ar</code><br><code>Singapore</code> - <code>2702</code>, <code>en</code><br><code>Spain</code> - <code>2724</code>, <code>es</code><br><code>United Arab Emirates</code> - <code>2784</code>, <code>ar</code><br><code>United Kingdom</code> - <code>2826</code>, <code>en</code><br><code>United States</code> - <code>2840</code>, <code>en</code><br>example:<br><code class=\"long-string\">United States</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": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><a name=\"loc\"></a><br><strong>Note:</strong> this endpoint currently supports the following locations and languages only:<p><code>Australia</code> - <code>2036</code>, <code>en</code><br><code>Austria</code> - <code>2040</code>, <code>de</code><br><code>Canada</code> - <code>2124</code>, <code>en</code><br><code>Egypt</code> - <code>2818</code>, <code>ar</code><br><code>France</code> - <code>2250</code>, <code>fr</code><br><code>Germany</code> - <code>2276</code>, <code>de</code><br><code>India</code> - <code>2356</code>, <code>en</code><br><code>Italy</code> - <code>2380</code>, <code>it</code><br><code>Mexico</code> - <code>2484</code>, <code>es</code><br><code>Netherlands</code> - <code>2528</code>, <code>nl</code><br><code>Saudi Arabia</code> - <code>2682</code>, <code>ar</code><br><code>Singapore</code> - <code>2702</code>, <code>en</code><br><code>Spain</code> - <code>2724</code>, <code>es</code><br><code>United Arab Emirates</code> - <code>2784</code>, <code>ar</code><br><code>United Kingdom</code> - <code>2826</code>, <code>en</code><br><code>United States</code> - <code>2840</code>, <code>en</code><br>example:<br><code class=\"long-string\">United States</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" + } +]
- Changed
post_dataforseo_labs_amazon_product_competitors_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "asin": { + "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", + "type": "string" + }, + "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"full_metrics.amazon_serp.pos_1\",\">\", 20]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned product competitors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", + "type": [ + "integer", + "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>[\"full_metrics.amazon_serp.pos_1,desc\"]</code><br><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>[\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</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" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "asin": "019005476X", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "asin": { - "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", - "type": "string" - }, - "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"full_metrics.amazon_serp.pos_1\",\">\", 20]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned product competitors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", - "type": [ - "integer", - "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>[\"full_metrics.amazon_serp.pos_1,desc\"]</code><br><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>[\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</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" - } -]
- Changed
post_dataforseo_labs_amazon_product_kw_overlap_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "asins": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>asins of target products</em><br><strong>required field</strong><br>product IDs of the products for which you need to find keyword intersections;<br>specify the ASINs as in the following example:<br><code>\"asins\": {<br>\"1\": \"019005476X\",<br>\"2\": \"0190074442\"<br>}</code><br><strong>the maximum number of ASINs you can specify in this object is 20;</strong><br>learn more about the parameter on <a href=\"https://dataforseo.com/help-center/how-to-get-amazon-product-data-using-asin\" rel=\"noopener noreferrer\" target=\"_blank\">this help center page</a>", + "type": [ + "object", + "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"avg_position\",\"<\", 10]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "intersection_mode": { + "description": "<em>mode for finding asin intersections</em><br>optional field<br>possible values: <code>union</code>, <code>intersect</code>;<br>default value: <code>intersect</code>;<br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/what-is-intersection-mode-in-amazon-keyword-intersections-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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>[\"sum_position,desc\"]</code><br><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>[\"intersections,desc\",\"avg_position,asc\"]</code><br>default rule:<br><code>[\"intersections,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "asins": { - "1": "B09172433Z", - "2": "B07GBZ4Q68", - "3": "B07GCKQD77" - }, - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "asins": { - "additionalProperties": { - "type": [ - "string", - "null" - ] - }, - "description": "<em>asins of target products</em><br><strong>required field</strong><br>product IDs of the products for which you need to find keyword intersections;<br>specify the ASINs as in the following example:<br><code>\"asins\": {<br>\"1\": \"019005476X\",<br>\"2\": \"0190074442\"<br>}</code><br><strong>the maximum number of ASINs you can specify in this object is 20;</strong><br>learn more about the parameter on <a href=\"https://dataforseo.com/help-center/how-to-get-amazon-product-data-using-asin\" rel=\"noopener noreferrer\" target=\"_blank\">this help center page</a>", - "type": [ - "object", - "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"avg_position\",\"<\", 10]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "intersection_mode": { - "description": "<em>mode for finding asin intersections</em><br>optional field<br>possible values: <code>union</code>, <code>intersect</code>;<br>default value: <code>intersect</code>;<br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/what-is-intersection-mode-in-amazon-keyword-intersections-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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>[\"sum_position,desc\"]</code><br><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>[\"intersections,desc\",\"avg_position,asc\"]</code><br>default rule:<br><code>[\"intersections,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" - ] - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_labs_amazon_product_rank_overview_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "asins": [ - "B001TJ3HUG", - "B01LW2SL7R" - ], - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "asins": { - "description": "<em>product IDs to compare</em><br><strong>required field</strong><br>product IDs to receive ranking data for;<br><strong>the maximum number of ASINs you can specify in this array is 1000;</strong><br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a><p><strong>Note:</strong> all letters in ASIN code must be specified in uppercase format;<br>example:<br><code>B01LW2SL7R</code>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</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": { + "asins": { + "description": "<em>product IDs to compare</em><br><strong>required field</strong><br>product IDs to receive ranking data for;<br><strong>the maximum number of ASINs you can specify in this array is 1000;</strong><br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a><p><strong>Note:</strong> all letters in ASIN code must be specified in uppercase format;<br>example:<br><code>B01LW2SL7R</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</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" + } +]
- Changed
post_dataforseo_labs_amazon_ranked_keywords_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "asin": { + "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", + "type": "string" + }, + "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>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>[\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]</code>;<p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "asin": "B00R92CL5E", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "asin": { - "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", - "type": "string" - }, - "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>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>[\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]</code>;<p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,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" - ] - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_labs_amazon_related_keywords_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "include_seed_keyword": true, - "keyword": "computer mouse", - "language_name": "English", - "limit": 5, - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code>;<br>number of the returned results depends on the value you set in this field;<br>you can specify a level from 0 to 4;<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 6 keywords<br>2 – 42 keywords<br>3 – 258 keywords<br>4 – 1554 keywords", - "type": [ - "integer", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "include_seed_keyword": { - "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords should be specified in the lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "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>keyword search depth</em><br>optional field<br>default value: <code>1</code>;<br>number of the returned results depends on the value you set in this field;<br>you can specify a level from 0 to 4;<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 6 keywords<br>2 – 42 keywords<br>3 – 258 keywords<br>4 – 1554 keywords", + "type": [ + "integer", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords should be specified in the lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "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" + } +]
- Changed
post_dataforseo_labs_apple_app_competitors_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.app_store_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "app_id": "686449807", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.app_store_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -]
- Changed
post_dataforseo_labs_apple_app_intersection_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "app_ids": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the ids should be specified the following way:<br>`\"app_ids\": {<br>\"1\": \"686449807\",<br>\"2\": \"382617920\"<br>}`<br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", + "type": [ + "object", + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "app_ids": { - "1": "686449807", - "2": "382617920" - }, - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "additionalProperties": { - "type": [ - "string", - "null" - ] - }, - "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the ids should be specified the following way:<br>`\"app_ids\": {<br>\"1\": \"686449807\",<br>\"2\": \"382617920\"<br>}`<br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", - "type": [ - "object", - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -]
- Changed
post_dataforseo_labs_apple_bulk_app_metrics_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "app_ids": [ - "686449807", - "382617920" - ], - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "description": "<em>ids of the apps</em><br><strong>required field</strong><br>IDs of mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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": { + "app_ids": { + "description": "<em>ids of the apps</em><br><strong>required field</strong><br>IDs of mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" + } +]
- Changed
post_dataforseo_labs_apple_keywords_for_app_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "app_id": "686449807", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -]
- Changed
post_dataforseo_labs_google_app_competitors_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.google_play_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.google_play_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -]
- Changed
post_dataforseo_labs_google_app_intersection_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "app_ids": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;;<br>the ids should be specified the following way:<br><code>\"app_ids\": {<br>\"1\": \"org.telegram.messenger\",<br>\"2\": \"com.zhiliaoapp.musically\"<br>}</code><br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", + "type": [ + "object", + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "app_ids": { - "1": "686449807", - "2": "382617920" - }, - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "additionalProperties": { - "type": [ - "string", - "null" - ] - }, - "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;;<br>the ids should be specified the following way:<br><code>\"app_ids\": {<br>\"1\": \"org.telegram.messenger\",<br>\"2\": \"com.zhiliaoapp.musically\"<br>}</code><br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", - "type": [ - "object", - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -]
- Changed
post_dataforseo_labs_google_bulk_app_metrics_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "app_ids": [ - "org.telegram.messenger", - "com.zhiliaoapp.musically" - ], - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "description": "<em>ids of the app</em><br><strong>required field</strong><br>IDs of the mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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": { + "app_ids": { + "description": "<em>ids of the app</em><br><strong>required field</strong><br>IDs of the mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" + } +]
- Changed
post_dataforseo_labs_google_bulk_keyword_difficulty_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keywords": [ - "dentist new york", - "pizza brooklyn", - "car dealer los angeles" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +]
- Changed
post_dataforseo_labs_google_bulk_traffic_estimation_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "item_types": [ - "organic", - "paid" - ], - "language_code": "en", - "location_code": 2840, - "targets": [ - "dataforseo.com", - "cnn.com", - "forbes.com" - ] - } - ], - "properties": { - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" - ] - }, - "targets": { - "description": "<em>target domains, subdomains, and webpages</em><br><strong>required field</strong><br>you can specify domains, subdomains, and webpages in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>pages should be specified with absolute URL, including <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains, subdomains or webpages", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" + ] + }, + "targets": { + "description": "<em>target domains, subdomains, and webpages</em><br><strong>required field</strong><br>you can specify domains, subdomains, and webpages in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>pages should be specified with absolute URL, including <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains, subdomains or webpages", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_categories_for_domain_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "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><br>example:<br><code>[\"metrics.organic.pos_1,\">\",0]</code><p><code>[[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]],<br>\"or\",<br>[\"metrics.organic.etv\",\"in\",[10,100]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and_<code>clickstream_age_distribution</code>_fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>n", + "type": [ + "boolean", + "null" + ] + }, + "include_subcategories": { + "description": "<em>indicates if the subcategories will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subcategories will be ignored<br>default value: <code>false</code><br>learn more about the parameter in this <a href=\"https://dataforseo.com/help-center/include_subcategories-in-categories-for-domain-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned categories</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned categories </em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain or subdomain</em><br><strong>required field</strong><br>the domain or subdomain name of the target website<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "item_types": [ - "paid", - "organic", - "featured_snippet", - "local_pack" - ], - "language_code": "en", - "limit": 3, - "location_name": "United States", - "target": "dataforseo.com" - } - ], - "properties": { - "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><br>example:<br><code>[\"metrics.organic.pos_1,\">\",0]</code><p><code>[[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]],<br>\"or\",<br>[\"metrics.organic.etv\",\"in\",[10,100]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "historical_serp_mode": { - "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", - "type": [ - "string", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and_<code>clickstream_age_distribution</code>_fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>n", - "type": [ - "boolean", - "null" - ] - }, - "include_subcategories": { - "description": "<em>indicates if the subcategories will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subcategories will be ignored<br>default value: <code>false</code><br>learn more about the parameter in this <a href=\"https://dataforseo.com/help-center/include_subcategories-in-categories-for-domain-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned categories</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned categories </em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", - "type": [ - "integer", - "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array", - "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" - ] - }, - "target": { - "description": "<em>domain or subdomain</em><br><strong>required field</strong><br>the domain or subdomain name of the target website<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_labs_google_categories_for_kw_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keywords": [ - "dentist new york", - "pizza brooklyn", - "car dealer los angeles" - ], - "language_code": "en" - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">English</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": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">English</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" + } +]
- Changed
post_dataforseo_labs_google_domain_rank_overview_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "language_name": "English", - "location_code": 2840, - "target": "dataforseo.com" - } - ], - "properties": { - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms<br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned results for domain</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned items</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten <code>items</code> in the results array will be omitted and the data will be provided for the successive items", - "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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms<br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned results for domain</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned items</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten <code>items</code> in the results array will be omitted and the data will be provided for the successive items", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_historical_bulk_traffic_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "date_from": "2021-01-01", - "date_to": "2021-03-29", - "item_types": [ - "organic", - "paid" - ], - "language_code": "en", - "location_code": 2840, - "targets": [ - "dataforseo.com", - "cnn.com", - "forbes.com" - ] - } - ], - "properties": { - "date_from": { - "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 12 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", - "type": [ - "string", - "null" - ] - }, - "date_to": { - "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response;<br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array;<br>possible values:<br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value:<br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" - ] - }, - "targets": { - "description": "<em>target domains and subdomains</em><br><strong>required field</strong><br>you can specify domains and subdomains in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains or subdomains", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "date_from": { + "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 12 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", + "type": [ + "string", + "null" + ] + }, + "date_to": { + "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response;<br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array;<br>possible values:<br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value:<br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" + ] + }, + "targets": { + "description": "<em>target domains and subdomains</em><br><strong>required field</strong><br>you can specify domains and subdomains in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains or subdomains", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_historical_keyword_data_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keywords": [ - "iphone" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "keywords": { - "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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": { + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +]
- Changed
post_dataforseo_labs_google_historical_rank_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "date_from": "2021-01-01", - "date_to": "2021-03-29", - "language_code": "en", - "location_code": 2840, - "target": "dataforseo.com" - } - ], - "properties": { - "correlate": { - "description": "<em>correlate data with previously obtained datasets</em><br>optional field<br>default value: <code>true</code><br>if you use this parameter, our system will correlate data you obtain now with previously obtained datasets<br>this parameter is intended to mitigate any inconsistencies that may result from changes to our database<br>we recommend always setting <code>correlate</code> to <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "date_from": { - "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 6 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", - "type": [ - "string", - "null" - ] - }, - "date_to": { - "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response;<br>default value: <code>false</code>;<p><strong>Note:</strong> historical clickstream data is available from 2024/05 (May, 2024);<br><strong>with this parameter enabled, you will be charged double the price for the request;</strong><br>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "correlate": { + "description": "<em>correlate data with previously obtained datasets</em><br>optional field<br>default value: <code>true</code><br>if you use this parameter, our system will correlate data you obtain now with previously obtained datasets<br>this parameter is intended to mitigate any inconsistencies that may result from changes to our database<br>we recommend always setting <code>correlate</code> to <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "date_from": { + "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 6 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", + "type": [ + "string", + "null" + ] + }, + "date_to": { + "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response;<br>default value: <code>false</code>;<p><strong>Note:</strong> historical clickstream data is available from 2024/05 (May, 2024);<br><strong>with this parameter enabled, you will be charged double the price for the request;</strong><br>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_keyword_ideas_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "closely_variants": { + "description": "<em>search mode</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> the results will be based on the phrase-match search algorithm<br>if set to <code class=\"prettyprint\">false</code> the results will be based on the broad-match search algorithm<br>default value: <code>false</code>n", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>The maximum number of keywords you can specify: 200.<br>The keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>700</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<p><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>[\"relevance,desc\",\"keyword_info.search_volume,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "include_serp_info": true, - "keywords": [ - "phone", - "watch" - ], - "language_code": "en", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "closely_variants": { - "description": "<em>search mode</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> the results will be based on the phrase-match search algorithm<br>if set to <code class=\"prettyprint\">false</code> the results will be based on the broad-match search algorithm<br>default value: <code>false</code>n", - "type": [ - "boolean", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keywords": { - "description": "<em>keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>The maximum number of keywords you can specify: 200.<br>The keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>700</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<p><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>[\"relevance,desc\",\"keyword_info.search_volume,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" - ] - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_labs_google_keyword_overview_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "include_clickstream_data": true, - "include_serp_info": true, - "keywords": [ - "iphone" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keywords": { - "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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": { + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +]
- Changed
post_dataforseo_labs_google_keyword_suggestions_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "exact_match": { + "description": "<em>search for the exact phrase</em><br>optional field<br>if set to <code>true</code>, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase<br>default value: <code>false</code>", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "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" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format;<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>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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>a comma is used as a separator<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "include_seed_keyword": true, - "include_serp_info": true, - "keyword": "phone", - "language_code": "en", - "limit": 1, - "location_code": 2840 - } - ], - "properties": { - "exact_match": { - "description": "<em>search for the exact phrase</em><br>optional field<br>if set to <code>true</code>, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase<br>default value: <code>false</code>", - "type": [ - "boolean", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_seed_keyword": { - "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format;<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>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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>a comma is used as a separator<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" - ] - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_labs_google_keywords_for_app_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "app_id": { + "description": "<em>id of the apps</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the apps</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -]
- Changed
post_dataforseo_labs_google_keywords_for_categories_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "category_codes": { + "description": "<em>product and service categories</em><br><strong>required field</strong><br>The maximum number of categories you can specify: 20<br>you can download <a href=\"https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv\">the full list of possible categories</a>", + "items": { + "type": "string" + }, + "type": "array" + }, + "category_intersection": { + "description": "<em>category intersections</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, you will get keywords featured in all specified categories;<br>if set to <code class=\"prettyprint\">false</code>, you will keywords that are specified in any of the specified categories;<br>default value: <code>true</code>", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "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" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]</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" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "category_codes": [ - "12191", - "12193" - ], - "include_serp_info": true, - "language_name": "English", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "category_codes": { - "description": "<em>product and service categories</em><br><strong>required field</strong><br>The maximum number of categories you can specify: 20<br>you can download <a href=\"https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv\">the full list of possible categories</a>", - "items": { - "type": "string" - }, - "type": "array" - }, - "category_intersection": { - "description": "<em>category intersections</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, you will get keywords featured in all specified categories;<br>if set to <code class=\"prettyprint\">false</code>, you will keywords that are specified in any of the specified categories;<br>default value: <code>true</code>", - "type": [ - "boolean", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]</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" - } -]
- Changed
post_dataforseo_labs_google_kw_for_site_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "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" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_subdomains": { + "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<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>[\"relevance,desc\",\"keyword_info.search_volume,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" + ] + }, + "target": { + "description": "<em>domain name or page url</em><br><strong>required field</strong><br>the domain name of the target website, subdomain or URL of the target webpage;<br>the <strong>domain name</strong> must be specified <strong>without</strong> <code>https://</code> or <code>www.</code>;<br>the <strong>subdomain</strong> must be specified <strong>without</strong> <code>https://</code>;<br>the <strong>webpage URL</strong> must be specified <strong>with</strong> <code>https://</code> or <code>www.</code><br><strong>Note:</strong> if you specify the <strong>webpage URL</strong> without <code>https://</code> or <code>www.</code>, the result will be returned for the <strong>entire domain</strong> rather than the specific page", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "filters": [ - "serp_info.se_results_count", - ">", - 0 - ], - "include_serp_info": true, - "include_subdomains": true, - "language_code": "en", - "limit": 3, - "location_code": 2840, - "target": "apple.com" - } - ], - "properties": { - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_subdomains": { - "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<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>[\"relevance,desc\",\"keyword_info.search_volume,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" - ] - }, - "target": { - "description": "<em>domain name or page url</em><br><strong>required field</strong><br>the domain name of the target website, subdomain or URL of the target webpage;<br>the <strong>domain name</strong> must be specified <strong>without</strong> <code>https://</code> or <code>www.</code>;<br>the <strong>subdomain</strong> must be specified <strong>without</strong> <code>https://</code>;<br>the <strong>webpage URL</strong> must be specified <strong>with</strong> <code>https://</code> or <code>www.</code><br><strong>Note:</strong> if you specify the <strong>webpage URL</strong> without <code>https://</code> or <code>www.</code>, the result will be returned for the <strong>entire domain</strong> rather than the specific page", - "type": "string" - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_labs_google_related_keywords_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "depth": { + "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code><p>number of the returned results depends on the value you set in this field<br>you can specify a level from 0 to 4<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 8 keywords<br>2 – 72 keywords<br>3 – 584 keywords<br>4 – 4680 keywords", + "type": [ + "integer", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_data.keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "ignore_synonyms": { + "description": "", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 type<br>example:<br><code>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "replace_with_core_keyword": { + "description": "<em>return data for core keyword</em><br>optional field<br>if <code>true</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the main keyword in the group that the specified <code>keyword</code> belongs to;<br>if <code>false</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the specified <code>keyword</code> (if available);<br>refer to <a href=\"https://dataforseo.com/help-center/replace_with_core_keyword\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a> for more details;<br>default value: <code>false</code>", + "type": [ + "boolean", + "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" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "keyword": "phone", - "language_name": "English", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code><p>number of the returned results depends on the value you set in this field<br>you can specify a level from 0 to 4<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 8 keywords<br>2 – 72 keywords<br>3 – 584 keywords<br>4 – 4680 keywords", - "type": [ - "integer", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_data.keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "", - "type": [ - "boolean", - "null" - ] - }, - "include_seed_keyword": { - "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 type<br>example:<br><code>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "replace_with_core_keyword": { - "description": "<em>return data for core keyword</em><br>optional field<br>if <code>true</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the main keyword in the group that the specified <code>keyword</code> belongs to;<br>if <code>false</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the specified <code>keyword</code> (if available);<br>refer to <a href=\"https://dataforseo.com/help-center/replace_with_core_keyword\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a> for more details;<br>default value: <code>false</code>", - "type": [ - "boolean", - "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" - } -]
- Changed
post_dataforseo_labs_google_relevant_pages_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "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><p>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]]</code><p><code>[[\"\"metrics.organic.count\",\">\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "filters": [ - [ - "metrics.organic.pos_1", - "<>", - 0 - ], - "or", - [ - "metrics.organic.pos_2_3", - "<>", - 0 - ] - ], - "language_name": "English", - "limit": 3, - "location_code": 2840, - "target": "amazon.com" - } - ], - "properties": { - "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><p>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]]</code><p><code>[[\"\"metrics.organic.count\",\">\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "historical_serp_mode": { - "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", - "type": [ - "integer", - "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_labs_google_search_intent_live1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "keywords": [ - "login page", - "audi a7", - "elon musk", - "milk store new york" - ] - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "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": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "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" + } +]
- Changed
post_dataforseo_labs_google_serp_competitors_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"median_position\",\"in\",[1,10]]</code><p><code>[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]</code><p><code>[[\"domain\",\"not_like\",\"%wikipedia.org%\"],<br>\"and\",<br>[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "include_subdomains": { + "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>search results type</em><br>indicates type of search results included in the response<br>optional field<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "keywords": { + "description": "<em>keywords array</em><br><strong>required field</strong><br>the results will be based on the keywords you specify in this array<br>UTF-8 encoding;<br>the keywords will be converted to lowercase format;<br><strong>you can specify the maximum of 200 keywords</strong><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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with <code>location_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", + "type": [ + "integer", + "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>the comma is used as a separator<br>example:<br><code>[\"avg_position,asc\"]</code><br>default rule:<br><code>[\"rating,desc\"]</code><br><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>[\"avg_position,asc\",\"etv,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "item_types": [ - "organic" - ], - "keywords": [ - "phone" - ], - "language_name": "English", - "limit": 5, - "location_code": 2840 - } - ], - "properties": { - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"median_position\",\"in\",[1,10]]</code><p><code>[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]</code><p><code>[[\"domain\",\"not_like\",\"%wikipedia.org%\"],<br>\"and\",<br>[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "include_subdomains": { - "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>search results type</em><br>indicates type of search results included in the response<br>optional field<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "keywords": { - "description": "<em>keywords array</em><br><strong>required field</strong><br>the results will be based on the keywords you specify in this array<br>UTF-8 encoding;<br>the keywords will be converted to lowercase format;<br><strong>you can specify the maximum of 200 keywords</strong><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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with <code>location_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", - "type": [ - "integer", - "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>the comma is used as a separator<br>example:<br><code>[\"avg_position,asc\"]</code><br>default rule:<br><code>[\"rating,desc\"]</code><br><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>[\"avg_position,asc\",\"etv,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" - ] - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_labs_google_subdomains_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "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><br>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]]</code><p><code>[[\"metrics.organic.count\",\">\",\"10\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "filters": [ - [ - "metrics.organic.pos_1", - "<>", - 0 - ], - "or", - [ - "metrics.organic.pos_2_3", - "<>", - 0 - ] - ], - "language_name": "English", - "location_code": 2840, - "target": "dataforseo.com" - } - ], - "properties": { - "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><br>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]]</code><p><code>[[\"metrics.organic.count\",\">\",\"10\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "historical_serp_mode": { - "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_labs_google_top_searches_live3 fields changed- added
Input 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." + } +} - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "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" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "language_name": "English", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" - ] - } - }, - "type": "object" - } -]
33 tool updates
- Changed
post_dataforseo_labs_amazon_bulk_volume_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "buy laptop", - "cheap laptops for sale", - "purchase laptop" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><a name=\"loc\"></a><br><strong>Note:</strong> this endpoint currently supports the following locations and languages only:<p><code>Australia</code> - <code>2036</code>, <code>en</code><br><code>Austria</code> - <code>2040</code>, <code>de</code><br><code>Canada</code> - <code>2124</code>, <code>en</code><br><code>Egypt</code> - <code>2818</code>, <code>ar</code><br><code>France</code> - <code>2250</code>, <code>fr</code><br><code>Germany</code> - <code>2276</code>, <code>de</code><br><code>India</code> - <code>2356</code>, <code>en</code><br><code>Italy</code> - <code>2380</code>, <code>it</code><br><code>Mexico</code> - <code>2484</code>, <code>es</code><br><code>Netherlands</code> - <code>2528</code>, <code>nl</code><br><code>Saudi Arabia</code> - <code>2682</code>, <code>ar</code><br><code>Singapore</code> - <code>2702</code>, <code>en</code><br><code>Spain</code> - <code>2724</code>, <code>es</code><br><code>United Arab Emirates</code> - <code>2784</code>, <code>ar</code><br><code>United Kingdom</code> - <code>2826</code>, <code>en</code><br><code>United States</code> - <code>2840</code>, <code>en</code><br>example:<br><code class=\"long-string\">United States</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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "buy laptop", + "cheap laptops for sale", + "purchase laptop" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><a name=\"loc\"></a><br><strong>Note:</strong> this endpoint currently supports the following locations and languages only:<p><code>Australia</code> - <code>2036</code>, <code>en</code><br><code>Austria</code> - <code>2040</code>, <code>de</code><br><code>Canada</code> - <code>2124</code>, <code>en</code><br><code>Egypt</code> - <code>2818</code>, <code>ar</code><br><code>France</code> - <code>2250</code>, <code>fr</code><br><code>Germany</code> - <code>2276</code>, <code>de</code><br><code>India</code> - <code>2356</code>, <code>en</code><br><code>Italy</code> - <code>2380</code>, <code>it</code><br><code>Mexico</code> - <code>2484</code>, <code>es</code><br><code>Netherlands</code> - <code>2528</code>, <code>nl</code><br><code>Saudi Arabia</code> - <code>2682</code>, <code>ar</code><br><code>Singapore</code> - <code>2702</code>, <code>en</code><br><code>Spain</code> - <code>2724</code>, <code>es</code><br><code>United Arab Emirates</code> - <code>2784</code>, <code>ar</code><br><code>United Kingdom</code> - <code>2826</code>, <code>en</code><br><code>United States</code> - <code>2840</code>, <code>en</code><br>example:<br><code class=\"long-string\">United States</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" + } +]
- Changed
post_dataforseo_labs_amazon_product_competitors_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "asin": "019005476X", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "asin": { - "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", - "type": "string" - }, - "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"full_metrics.amazon_serp.pos_1\",\">\", 20]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned product competitors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", - "type": [ - "integer", - "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>[\"full_metrics.amazon_serp.pos_1,desc\"]</code><br><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>[\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "asin": "019005476X", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "asin": { + "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", + "type": "string" + }, + "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"full_metrics.amazon_serp.pos_1\",\">\", 20]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned product competitors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", + "type": [ + "integer", + "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>[\"full_metrics.amazon_serp.pos_1,desc\"]</code><br><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>[\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</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" + } +]
- Changed
post_dataforseo_labs_amazon_product_kw_overlap_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "asins": { - "1": "B09172433Z", - "2": "B07GBZ4Q68", - "3": "B07GCKQD77" - }, - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "asins": { - "additionalProperties": { - "type": [ - "string", - "null" - ] - }, - "description": "<em>asins of target products</em><br><strong>required field</strong><br>product IDs of the products for which you need to find keyword intersections;<br>specify the ASINs as in the following example:<br><code>\"asins\": {<br>\"1\": \"019005476X\",<br>\"2\": \"0190074442\"<br>}</code><br><strong>the maximum number of ASINs you can specify in this object is 20;</strong><br>learn more about the parameter on <a href=\"https://dataforseo.com/help-center/how-to-get-amazon-product-data-using-asin\" rel=\"noopener noreferrer\" target=\"_blank\">this help center page</a>", - "type": [ - "object", - "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"avg_position\",\"<\", 10]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "intersection_mode": { - "description": "<em>mode for finding asin intersections</em><br>optional field<br>possible values: <code>union</code>, <code>intersect</code>;<br>default value: <code>intersect</code>;<br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/what-is-intersection-mode-in-amazon-keyword-intersections-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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>[\"sum_position,desc\"]</code><br><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>[\"intersections,desc\",\"avg_position,asc\"]</code><br>default rule:<br><code>[\"intersections,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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "asins": { + "1": "B09172433Z", + "2": "B07GBZ4Q68", + "3": "B07GCKQD77" + }, + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "asins": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>asins of target products</em><br><strong>required field</strong><br>product IDs of the products for which you need to find keyword intersections;<br>specify the ASINs as in the following example:<br><code>\"asins\": {<br>\"1\": \"019005476X\",<br>\"2\": \"0190074442\"<br>}</code><br><strong>the maximum number of ASINs you can specify in this object is 20;</strong><br>learn more about the parameter on <a href=\"https://dataforseo.com/help-center/how-to-get-amazon-product-data-using-asin\" rel=\"noopener noreferrer\" target=\"_blank\">this help center page</a>", + "type": [ + "object", + "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"avg_position\",\"<\", 10]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "intersection_mode": { + "description": "<em>mode for finding asin intersections</em><br>optional field<br>possible values: <code>union</code>, <code>intersect</code>;<br>default value: <code>intersect</code>;<br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/what-is-intersection-mode-in-amazon-keyword-intersections-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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>[\"sum_position,desc\"]</code><br><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>[\"intersections,desc\",\"avg_position,asc\"]</code><br>default rule:<br><code>[\"intersections,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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_amazon_product_rank_overview_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "asins": [ - "B001TJ3HUG", - "B01LW2SL7R" - ], - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "asins": { - "description": "<em>product IDs to compare</em><br><strong>required field</strong><br>product IDs to receive ranking data for;<br><strong>the maximum number of ASINs you can specify in this array is 1000;</strong><br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a><p><strong>Note:</strong> all letters in ASIN code must be specified in uppercase format;<br>example:<br><code>B01LW2SL7R</code>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "asins": [ + "B001TJ3HUG", + "B01LW2SL7R" + ], + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "asins": { + "description": "<em>product IDs to compare</em><br><strong>required field</strong><br>product IDs to receive ranking data for;<br><strong>the maximum number of ASINs you can specify in this array is 1000;</strong><br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a><p><strong>Note:</strong> all letters in ASIN code must be specified in uppercase format;<br>example:<br><code>B01LW2SL7R</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</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" + } +]
- Changed
post_dataforseo_labs_amazon_ranked_keywords_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "asin": "B00R92CL5E", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "asin": { - "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", - "type": "string" - }, - "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>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>[\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]</code>;<p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "asin": "B00R92CL5E", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "asin": { + "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", + "type": "string" + }, + "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>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>[\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]</code>;<p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_amazon_related_keywords_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "include_seed_keyword": true, - "keyword": "computer mouse", - "language_name": "English", - "limit": 5, - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code>;<br>number of the returned results depends on the value you set in this field;<br>you can specify a level from 0 to 4;<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 6 keywords<br>2 – 42 keywords<br>3 – 258 keywords<br>4 – 1554 keywords", - "type": [ - "integer", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "include_seed_keyword": { - "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords should be specified in the lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "include_seed_keyword": true, + "keyword": "computer mouse", + "language_name": "English", + "limit": 5, + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code>;<br>number of the returned results depends on the value you set in this field;<br>you can specify a level from 0 to 4;<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 6 keywords<br>2 – 42 keywords<br>3 – 258 keywords<br>4 – 1554 keywords", + "type": [ + "integer", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords should be specified in the lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "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" + } +]
- Changed
post_dataforseo_labs_apple_app_competitors_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "686449807", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.app_store_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.app_store_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +]
- Changed
post_dataforseo_labs_apple_app_intersection_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_ids": { - "1": "686449807", - "2": "382617920" - }, - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "additionalProperties": { - "type": [ - "string", - "null" - ] - }, - "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the ids should be specified the following way:<br>`\"app_ids\": {<br>\"1\": \"686449807\",<br>\"2\": \"382617920\"<br>}`<br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", - "type": [ - "object", - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the ids should be specified the following way:<br>`\"app_ids\": {<br>\"1\": \"686449807\",<br>\"2\": \"382617920\"<br>}`<br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", + "type": [ + "object", + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +]
- Changed
post_dataforseo_labs_apple_bulk_app_metrics_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_ids": [ - "686449807", - "382617920" - ], - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "description": "<em>ids of the apps</em><br><strong>required field</strong><br>IDs of mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_ids": [ + "686449807", + "382617920" + ], + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "description": "<em>ids of the apps</em><br><strong>required field</strong><br>IDs of mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" + } +]
- Changed
post_dataforseo_labs_apple_keywords_for_app_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "686449807", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +]
- Changed
post_dataforseo_labs_google_app_competitors_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.google_play_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.google_play_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +]
- Changed
post_dataforseo_labs_google_app_intersection_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_ids": { - "1": "686449807", - "2": "382617920" - }, - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "additionalProperties": { - "type": [ - "string", - "null" - ] - }, - "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;;<br>the ids should be specified the following way:<br><code>\"app_ids\": {<br>\"1\": \"org.telegram.messenger\",<br>\"2\": \"com.zhiliaoapp.musically\"<br>}</code><br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", - "type": [ - "object", - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;;<br>the ids should be specified the following way:<br><code>\"app_ids\": {<br>\"1\": \"org.telegram.messenger\",<br>\"2\": \"com.zhiliaoapp.musically\"<br>}</code><br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", + "type": [ + "object", + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +]
- Changed
post_dataforseo_labs_google_bulk_app_metrics_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_ids": [ - "org.telegram.messenger", - "com.zhiliaoapp.musically" - ], - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "description": "<em>ids of the app</em><br><strong>required field</strong><br>IDs of the mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_ids": [ + "org.telegram.messenger", + "com.zhiliaoapp.musically" + ], + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "description": "<em>ids of the app</em><br><strong>required field</strong><br>IDs of the mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" + } +]
- Changed
post_dataforseo_labs_google_bulk_keyword_difficulty_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "dentist new york", - "pizza brooklyn", - "car dealer los angeles" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +]
- Changed
post_dataforseo_labs_google_bulk_traffic_estimation_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "item_types": [ - "organic", - "paid" - ], - "language_code": "en", - "location_code": 2840, - "targets": [ - "dataforseo.com", - "cnn.com", - "forbes.com" - ] - } - ], - "properties": { - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" - ] - }, - "targets": { - "description": "<em>target domains, subdomains, and webpages</em><br><strong>required field</strong><br>you can specify domains, subdomains, and webpages in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>pages should be specified with absolute URL, including <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains, subdomains or webpages", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } + ], + "properties": { + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" + ] + }, + "targets": { + "description": "<em>target domains, subdomains, and webpages</em><br><strong>required field</strong><br>you can specify domains, subdomains, and webpages in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>pages should be specified with absolute URL, including <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains, subdomains or webpages", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_categories_for_domain_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "item_types": [ - "paid", - "organic", - "featured_snippet", - "local_pack" - ], - "language_code": "en", - "limit": 3, - "location_name": "United States", - "target": "dataforseo.com" - } - ], - "properties": { - "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><br>example:<br><code>[\"metrics.organic.pos_1,\">\",0]</code><p><code>[[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]],<br>\"or\",<br>[\"metrics.organic.etv\",\"in\",[10,100]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "historical_serp_mode": { - "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", - "type": [ - "string", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and_<code>clickstream_age_distribution</code>_fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>n", - "type": [ - "boolean", - "null" - ] - }, - "include_subcategories": { - "description": "<em>indicates if the subcategories will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subcategories will be ignored<br>default value: <code>false</code><br>learn more about the parameter in this <a href=\"https://dataforseo.com/help-center/include_subcategories-in-categories-for-domain-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned categories</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned categories </em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", - "type": [ - "integer", - "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array", - "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" - ] - }, - "target": { - "description": "<em>domain or subdomain</em><br><strong>required field</strong><br>the domain or subdomain name of the target website<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "item_types": [ + "paid", + "organic", + "featured_snippet", + "local_pack" + ], + "language_code": "en", + "limit": 3, + "location_name": "United States", + "target": "dataforseo.com" + } + ], + "properties": { + "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><br>example:<br><code>[\"metrics.organic.pos_1,\">\",0]</code><p><code>[[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]],<br>\"or\",<br>[\"metrics.organic.etv\",\"in\",[10,100]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and_<code>clickstream_age_distribution</code>_fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>n", + "type": [ + "boolean", + "null" + ] + }, + "include_subcategories": { + "description": "<em>indicates if the subcategories will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subcategories will be ignored<br>default value: <code>false</code><br>learn more about the parameter in this <a href=\"https://dataforseo.com/help-center/include_subcategories-in-categories-for-domain-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned categories</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned categories </em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain or subdomain</em><br><strong>required field</strong><br>the domain or subdomain name of the target website<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_categories_for_kw_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "dentist new york", - "pizza brooklyn", - "car dealer los angeles" - ], - "language_code": "en" - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">English</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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en" + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">English</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" + } +]
- Changed
post_dataforseo_labs_google_domain_rank_overview_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_name": "English", - "location_code": 2840, - "target": "dataforseo.com" - } - ], - "properties": { - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms<br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned results for domain</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned items</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten <code>items</code> in the results array will be omitted and the data will be provided for the successive items", - "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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } + ], + "properties": { + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms<br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned results for domain</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned items</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten <code>items</code> in the results array will be omitted and the data will be provided for the successive items", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_historical_bulk_traffic_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "date_from": "2021-01-01", - "date_to": "2021-03-29", - "item_types": [ - "organic", - "paid" - ], - "language_code": "en", - "location_code": 2840, - "targets": [ - "dataforseo.com", - "cnn.com", - "forbes.com" - ] - } - ], - "properties": { - "date_from": { - "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 12 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", - "type": [ - "string", - "null" - ] - }, - "date_to": { - "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response;<br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array;<br>possible values:<br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value:<br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" - ] - }, - "targets": { - "description": "<em>target domains and subdomains</em><br><strong>required field</strong><br>you can specify domains and subdomains in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains or subdomains", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } + ], + "properties": { + "date_from": { + "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 12 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", + "type": [ + "string", + "null" + ] + }, + "date_to": { + "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response;<br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array;<br>possible values:<br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value:<br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" + ] + }, + "targets": { + "description": "<em>target domains and subdomains</em><br><strong>required field</strong><br>you can specify domains and subdomains in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains or subdomains", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_historical_keyword_data_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "iphone" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "keywords": { - "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +]
- Changed
post_dataforseo_labs_google_historical_rank_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "date_from": "2021-01-01", - "date_to": "2021-03-29", - "language_code": "en", - "location_code": 2840, - "target": "dataforseo.com" - } - ], - "properties": { - "correlate": { - "description": "<em>correlate data with previously obtained datasets</em><br>optional field<br>default value: <code>true</code><br>if you use this parameter, our system will correlate data you obtain now with previously obtained datasets<br>this parameter is intended to mitigate any inconsistencies that may result from changes to our database<br>we recommend always setting <code>correlate</code> to <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "date_from": { - "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 6 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", - "type": [ - "string", - "null" - ] - }, - "date_to": { - "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response;<br>default value: <code>false</code>;<p><strong>Note:</strong> historical clickstream data is available from 2024/05 (May, 2024);<br><strong>with this parameter enabled, you will be charged double the price for the request;</strong><br>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "language_code": "en", + "location_code": 2840, + "target": "dataforseo.com" + } + ], + "properties": { + "correlate": { + "description": "<em>correlate data with previously obtained datasets</em><br>optional field<br>default value: <code>true</code><br>if you use this parameter, our system will correlate data you obtain now with previously obtained datasets<br>this parameter is intended to mitigate any inconsistencies that may result from changes to our database<br>we recommend always setting <code>correlate</code> to <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "date_from": { + "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 6 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", + "type": [ + "string", + "null" + ] + }, + "date_to": { + "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response;<br>default value: <code>false</code>;<p><strong>Note:</strong> historical clickstream data is available from 2024/05 (May, 2024);<br><strong>with this parameter enabled, you will be charged double the price for the request;</strong><br>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_keyword_ideas_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "include_serp_info": true, - "keywords": [ - "phone", - "watch" - ], - "language_code": "en", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "closely_variants": { - "description": "<em>search mode</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> the results will be based on the phrase-match search algorithm<br>if set to <code class=\"prettyprint\">false</code> the results will be based on the broad-match search algorithm<br>default value: <code>false</code>n", - "type": [ - "boolean", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keywords": { - "description": "<em>keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>The maximum number of keywords you can specify: 200.<br>The keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>700</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<p><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>[\"relevance,desc\",\"keyword_info.search_volume,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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "include_serp_info": true, + "keywords": [ + "phone", + "watch" + ], + "language_code": "en", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "closely_variants": { + "description": "<em>search mode</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> the results will be based on the phrase-match search algorithm<br>if set to <code class=\"prettyprint\">false</code> the results will be based on the broad-match search algorithm<br>default value: <code>false</code>n", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>The maximum number of keywords you can specify: 200.<br>The keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>700</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<p><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>[\"relevance,desc\",\"keyword_info.search_volume,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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_keyword_overview_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "include_clickstream_data": true, - "include_serp_info": true, - "keywords": [ - "iphone" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keywords": { - "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "include_clickstream_data": true, + "include_serp_info": true, + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +]
- Changed
post_dataforseo_labs_google_keyword_suggestions_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "include_seed_keyword": true, - "include_serp_info": true, - "keyword": "phone", - "language_code": "en", - "limit": 1, - "location_code": 2840 - } - ], - "properties": { - "exact_match": { - "description": "<em>search for the exact phrase</em><br>optional field<br>if set to <code>true</code>, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase<br>default value: <code>false</code>", - "type": [ - "boolean", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_seed_keyword": { - "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format;<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>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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>a comma is used as a separator<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "include_seed_keyword": true, + "include_serp_info": true, + "keyword": "phone", + "language_code": "en", + "limit": 1, + "location_code": 2840 + } + ], + "properties": { + "exact_match": { + "description": "<em>search for the exact phrase</em><br>optional field<br>if set to <code>true</code>, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase<br>default value: <code>false</code>", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format;<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>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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>a comma is used as a separator<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_keywords_for_app_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the apps</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the apps</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +]
- Changed
post_dataforseo_labs_google_keywords_for_categories_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "category_codes": [ - "12191", - "12193" - ], - "include_serp_info": true, - "language_name": "English", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "category_codes": { - "description": "<em>product and service categories</em><br><strong>required field</strong><br>The maximum number of categories you can specify: 20<br>you can download <a href=\"https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv\">the full list of possible categories</a>", - "items": { - "type": "string" - }, - "type": "array" - }, - "category_intersection": { - "description": "<em>category intersections</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, you will get keywords featured in all specified categories;<br>if set to <code class=\"prettyprint\">false</code>, you will keywords that are specified in any of the specified categories;<br>default value: <code>true</code>", - "type": [ - "boolean", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]</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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "category_codes": [ + "12191", + "12193" + ], + "include_serp_info": true, + "language_name": "English", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "category_codes": { + "description": "<em>product and service categories</em><br><strong>required field</strong><br>The maximum number of categories you can specify: 20<br>you can download <a href=\"https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv\">the full list of possible categories</a>", + "items": { + "type": "string" + }, + "type": "array" + }, + "category_intersection": { + "description": "<em>category intersections</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, you will get keywords featured in all specified categories;<br>if set to <code class=\"prettyprint\">false</code>, you will keywords that are specified in any of the specified categories;<br>default value: <code>true</code>", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]</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" + } +]
- Changed
post_dataforseo_labs_google_kw_for_site_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "filters": [ - "serp_info.se_results_count", - ">", - 0 - ], - "include_serp_info": true, - "include_subdomains": true, - "language_code": "en", - "limit": 3, - "location_code": 2840, - "target": "apple.com" - } - ], - "properties": { - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_subdomains": { - "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<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>[\"relevance,desc\",\"keyword_info.search_volume,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" - ] - }, - "target": { - "description": "<em>domain name or page url</em><br><strong>required field</strong><br>the domain name of the target website, subdomain or URL of the target webpage;<br>the <strong>domain name</strong> must be specified <strong>without</strong> <code>https://</code> or <code>www.</code>;<br>the <strong>subdomain</strong> must be specified <strong>without</strong> <code>https://</code>;<br>the <strong>webpage URL</strong> must be specified <strong>with</strong> <code>https://</code> or <code>www.</code><br><strong>Note:</strong> if you specify the <strong>webpage URL</strong> without <code>https://</code> or <code>www.</code>, the result will be returned for the <strong>entire domain</strong> rather than the specific page", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "filters": [ + "serp_info.se_results_count", + ">", + 0 + ], + "include_serp_info": true, + "include_subdomains": true, + "language_code": "en", + "limit": 3, + "location_code": 2840, + "target": "apple.com" + } + ], + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_subdomains": { + "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<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>[\"relevance,desc\",\"keyword_info.search_volume,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" + ] + }, + "target": { + "description": "<em>domain name or page url</em><br><strong>required field</strong><br>the domain name of the target website, subdomain or URL of the target webpage;<br>the <strong>domain name</strong> must be specified <strong>without</strong> <code>https://</code> or <code>www.</code>;<br>the <strong>subdomain</strong> must be specified <strong>without</strong> <code>https://</code>;<br>the <strong>webpage URL</strong> must be specified <strong>with</strong> <code>https://</code> or <code>www.</code><br><strong>Note:</strong> if you specify the <strong>webpage URL</strong> without <code>https://</code> or <code>www.</code>, the result will be returned for the <strong>entire domain</strong> rather than the specific page", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_related_keywords_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "phone", - "language_name": "English", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code><p>number of the returned results depends on the value you set in this field<br>you can specify a level from 0 to 4<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 8 keywords<br>2 – 72 keywords<br>3 – 584 keywords<br>4 – 4680 keywords", - "type": [ - "integer", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_data.keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "", - "type": [ - "boolean", - "null" - ] - }, - "include_seed_keyword": { - "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 type<br>example:<br><code>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "replace_with_core_keyword": { - "description": "<em>return data for core keyword</em><br>optional field<br>if <code>true</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the main keyword in the group that the specified <code>keyword</code> belongs to;<br>if <code>false</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the specified <code>keyword</code> (if available);<br>refer to <a href=\"https://dataforseo.com/help-center/replace_with_core_keyword\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a> for more details;<br>default value: <code>false</code>", - "type": [ - "boolean", - "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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keyword": "phone", + "language_name": "English", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code><p>number of the returned results depends on the value you set in this field<br>you can specify a level from 0 to 4<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 8 keywords<br>2 – 72 keywords<br>3 – 584 keywords<br>4 – 4680 keywords", + "type": [ + "integer", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_data.keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 type<br>example:<br><code>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "replace_with_core_keyword": { + "description": "<em>return data for core keyword</em><br>optional field<br>if <code>true</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the main keyword in the group that the specified <code>keyword</code> belongs to;<br>if <code>false</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the specified <code>keyword</code> (if available);<br>refer to <a href=\"https://dataforseo.com/help-center/replace_with_core_keyword\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a> for more details;<br>default value: <code>false</code>", + "type": [ + "boolean", + "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" + } +]
- Changed
post_dataforseo_labs_google_relevant_pages_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "filters": [ - [ - "metrics.organic.pos_1", - "<>", - 0 - ], - "or", - [ - "metrics.organic.pos_2_3", - "<>", - 0 - ] - ], - "language_name": "English", - "limit": 3, - "location_code": 2840, - "target": "amazon.com" - } - ], - "properties": { - "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><p>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]]</code><p><code>[[\"\"metrics.organic.count\",\">\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "historical_serp_mode": { - "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", - "type": [ - "integer", - "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "limit": 3, + "location_code": 2840, + "target": "amazon.com" + } + ], + "properties": { + "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><p>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]]</code><p><code>[[\"\"metrics.organic.count\",\">\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_search_intent_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "login page", - "audi a7", - "elon musk", - "milk store new york" - ] - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "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" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "login page", + "audi a7", + "elon musk", + "milk store new york" + ] + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "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" + } +]
- Changed
post_dataforseo_labs_google_serp_competitors_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "item_types": [ - "organic" - ], - "keywords": [ - "phone" - ], - "language_name": "English", - "limit": 5, - "location_code": 2840 - } - ], - "properties": { - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"median_position\",\"in\",[1,10]]</code><p><code>[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]</code><p><code>[[\"domain\",\"not_like\",\"%wikipedia.org%\"],<br>\"and\",<br>[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "include_subdomains": { - "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>search results type</em><br>indicates type of search results included in the response<br>optional field<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "keywords": { - "description": "<em>keywords array</em><br><strong>required field</strong><br>the results will be based on the keywords you specify in this array<br>UTF-8 encoding;<br>the keywords will be converted to lowercase format;<br><strong>you can specify the maximum of 200 keywords</strong><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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with <code>location_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", - "type": [ - "integer", - "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>the comma is used as a separator<br>example:<br><code>[\"avg_position,asc\"]</code><br>default rule:<br><code>[\"rating,desc\"]</code><br><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>[\"avg_position,asc\",\"etv,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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "item_types": [ + "organic" + ], + "keywords": [ + "phone" + ], + "language_name": "English", + "limit": 5, + "location_code": 2840 + } + ], + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"median_position\",\"in\",[1,10]]</code><p><code>[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]</code><p><code>[[\"domain\",\"not_like\",\"%wikipedia.org%\"],<br>\"and\",<br>[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "include_subdomains": { + "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>search results type</em><br>indicates type of search results included in the response<br>optional field<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "keywords": { + "description": "<em>keywords array</em><br><strong>required field</strong><br>the results will be based on the keywords you specify in this array<br>UTF-8 encoding;<br>the keywords will be converted to lowercase format;<br><strong>you can specify the maximum of 200 keywords</strong><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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with <code>location_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", + "type": [ + "integer", + "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>the comma is used as a separator<br>example:<br><code>[\"avg_position,asc\"]</code><br>default rule:<br><code>[\"rating,desc\"]</code><br><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>[\"avg_position,asc\",\"etv,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" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_subdomains_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "filters": [ - [ - "metrics.organic.pos_1", - "<>", - 0 - ], - "or", - [ - "metrics.organic.pos_2_3", - "<>", - 0 - ] - ], - "language_name": "English", - "location_code": 2840, - "target": "dataforseo.com" - } - ], - "properties": { - "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><br>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]]</code><p><code>[[\"metrics.organic.count\",\">\",\"10\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "historical_serp_mode": { - "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } + ], + "properties": { + "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><br>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]]</code><p><code>[[\"metrics.organic.count\",\">\",\"10\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_labs_google_top_searches_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_name": "English", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +]
52 tool updates
- Added
batch_get_schema - Added
batch_quote - Changed
batch_use18 fields changed- added
Input schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - removed
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" - added
Input schema / properties / calls / items / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - changed
Input schema / properties / calls / items / additionalPropertiesPrevious value: -trueNew value: +false - added
Input 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" + } +} - added
Input schema / properties / calls / items / requiredAdded value: +[ + "call_id", + "tool", + "arguments" +] - added
Input schema / properties / calls / maxItemsAdded value: +20 - added
Input schema / properties / calls / minItemsAdded value: +1 - removed
Input schema / properties / max_price_usdRemoved value: -{ - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "default": null, - "description": "Per-call price cap applied to every item" -} - removed
Input schema / properties / search_id / anyOfRemoved value: -[ - { - "type": "string" - }, - { - "type": "null" - } -] - removed
Input schema / properties / search_id / defaultRemoved value: -null - changed
Input schema / properties / search_id / descriptionPrevious value: -"search_id from the search that found these operations"New value: +"Optional search correlation identifier returned by search." - added
Input schema / properties / search_id / typeAdded value: +"string" - added
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" +} - added
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." + } +} - added
Output schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - added
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" + } +} - added
Output schema / requiredAdded value: +[ + "session_id", + "batch_id", + "total_count", + "success_count", + "error_count", + "results", + "next_steps_guidance" +]
- Changed
get_ahrefs_domain_rating2 fields changed- added
Input schema / properties / target / exampleAdded value: +"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "target", - "date" -]New value: +[ + "date", + "target" +]
- Changed
get_ahrefs_site_metrics2 fields changed- added
Input schema / properties / target / exampleAdded value: +"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "target", - "date" -]New value: +[ + "date", + "target" +]
- Changed
get_dataforseo_labs_available_filters1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_labs_google_available_history1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_labs_google_categories_for_kw_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_labs_status1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_details13 fields changed- added
Input schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - removed
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." -} - added
Input schema / properties / include_arguments_schemaAdded value: +{ + "default": true, + "description": "Return the complete arguments_schema. Defaults to true.", + "type": "boolean" +} - changed
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." - added
Input schema / properties / include_response_schemaAdded value: +{ + "default": false, + "description": "Return the complete response_schema. Defaults to false.", + "type": "boolean" +} - removed
Input schema / properties / operation_idRemoved value: -{ - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "description": "One operation_id from search" -} - removed
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" -} - added
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" +} - added
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 +} - removed
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" -} - added
Input schema / requiredAdded value: +[ + "tools" +] - added
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" + } +} - added
Output schema / requiredAdded value: +[ + "error_count", + "next_steps_guidance", + "session_id", + "success_count", + "tools", + "total_count" +]
- Changed
get_semrush_domain_organic_keywords5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`." - removed
Input schema / properties / domain / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "domain", - "database" -]New value: +[ + "database", + "domain" +]
- Changed
get_semrush_domain_overview2 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code. Defaults to `us`. Examples: `us`, `uk`, `cn`." - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`."
- Changed
get_semrush_domain_paid_keywords5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`." - removed
Input schema / properties / domain / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "domain", - "database" -]New value: +[ + "database", + "domain" +]
- Changed
get_semrush_domain_rank_history5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`." - removed
Input schema / properties / domain / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "domain", - "database" -]New value: +[ + "database", + "domain" +]
- Changed
get_semrush_domain_vs_domain5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domains / descriptionRemoved value: -"Comparison spec: `sign|type|domain` groups joined by `|` (sign in + - * /, type in `or`/`ad`). Example: `+|or|ahrefs.com|+|or|semrush.com`." - removed
Input schema / properties / domains / exampleRemoved value: -"+|or|ahrefs.com|+|or|semrush.com" - changed
Input schema / requiredPrevious value: -[ - "domains", - "database" -]New value: +[ + "database", + "domains" +]
- Changed
get_semrush_organic_competitors5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`." - removed
Input schema / properties / domain / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "domain", - "database" -]New value: +[ + "database", + "domain" +]
- Changed
get_semrush_url_organic_keywords5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / url / descriptionRemoved value: -"Target URL (landing page)." - removed
Input schema / properties / url / exampleRemoved value: -"https://ahrefs.com/blog/" - changed
Input schema / requiredPrevious value: -[ - "url", - "database" -]New value: +[ + "database", + "url" +]
- Changed
post_dataforseo_labs_amazon_bulk_volume_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "buy laptop", + "cheap laptops for sale", + "purchase laptop" + ], + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "buy laptop", + "cheap laptops for sale", + "purchase laptop" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><a name=\"loc\"></a><br><strong>Note:</strong> this endpoint currently supports the following locations and languages only:<p><code>Australia</code> - <code>2036</code>, <code>en</code><br><code>Austria</code> - <code>2040</code>, <code>de</code><br><code>Canada</code> - <code>2124</code>, <code>en</code><br><code>Egypt</code> - <code>2818</code>, <code>ar</code><br><code>France</code> - <code>2250</code>, <code>fr</code><br><code>Germany</code> - <code>2276</code>, <code>de</code><br><code>India</code> - <code>2356</code>, <code>en</code><br><code>Italy</code> - <code>2380</code>, <code>it</code><br><code>Mexico</code> - <code>2484</code>, <code>es</code><br><code>Netherlands</code> - <code>2528</code>, <code>nl</code><br><code>Saudi Arabia</code> - <code>2682</code>, <code>ar</code><br><code>Singapore</code> - <code>2702</code>, <code>en</code><br><code>Spain</code> - <code>2724</code>, <code>es</code><br><code>United Arab Emirates</code> - <code>2784</code>, <code>ar</code><br><code>United Kingdom</code> - <code>2826</code>, <code>en</code><br><code>United States</code> - <code>2840</code>, <code>en</code><br>example:<br><code class=\"long-string\">United States</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these locations and languages only; example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these locations and languages only; example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports these locations and languages only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the following locations and languages only: Australia – 2036, en Austria – 2040, de Canada – 2124, en Egypt – 2818, ar France – 2250, fr Germany – 2276, de India – 2356, en Italy – 2380, it Mexico – 2484, es Netherlands – 2528, nl Saudi Arabia – 2682, ar Singapore – 2702, en Spain – 2724, es United Arab Emirates – 2784, ar United Kingdom – 2826, en United States – 2840, en example: United States", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_product_competitors_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "asin": "019005476X", + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "asin": "019005476X", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "asin": { + "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", + "type": "string" + }, + "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"full_metrics.amazon_serp.pos_1\",\">\", 20]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned product competitors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", + "type": [ + "integer", + "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>[\"full_metrics.amazon_serp.pos_1,desc\"]</code><br><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>[\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "asin": { - "description": "product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint", - "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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"full_metrics.amazon_serp.pos_1\",\">\", 20] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of products in the results array optional field default value: 100; maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned product competitors optional field default value: 0 if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", - "type": "integer" - }, - "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: [\"full_metrics.amazon_serp.pos_1,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"] default rule: [\"ranked_serp_element.serp_item.rank_group,asc\"]", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "asin" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_product_kw_overlap_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "asins": { + "1": "B09172433Z", + "2": "B07GBZ4Q68", + "3": "B07GCKQD77" + }, + "language_name": "English", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "asins": { + "1": "B09172433Z", + "2": "B07GBZ4Q68", + "3": "B07GCKQD77" + }, + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "asins": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>asins of target products</em><br><strong>required field</strong><br>product IDs of the products for which you need to find keyword intersections;<br>specify the ASINs as in the following example:<br><code>\"asins\": {<br>\"1\": \"019005476X\",<br>\"2\": \"0190074442\"<br>}</code><br><strong>the maximum number of ASINs you can specify in this object is 20;</strong><br>learn more about the parameter on <a href=\"https://dataforseo.com/help-center/how-to-get-amazon-product-data-using-asin\" rel=\"noopener noreferrer\" target=\"_blank\">this help center page</a>", + "type": [ + "object", + "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"avg_position\",\"<\", 10]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "intersection_mode": { + "description": "<em>mode for finding asin intersections</em><br>optional field<br>possible values: <code>union</code>, <code>intersect</code>;<br>default value: <code>intersect</code>;<br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/what-is-intersection-mode-in-amazon-keyword-intersections-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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>[\"sum_position,desc\"]</code><br><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>[\"intersections,desc\",\"avg_position,asc\"]</code><br>default rule:<br><code>[\"intersections,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "asins": { - "additionalProperties": { - "type": "string" - }, - "description": "asins of target products required field product IDs of the products for which you need to find keyword intersections; specify the ASINs as in the following example: \"asins\": { \"1\": \"019005476X\", \"2\": \"0190074442\" } the maximum number of ASINs you can specify in this object is 20; learn more about the parameter on this help center page", - "type": "object" - }, - "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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"avg_position\",\"<\", 10] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "intersection_mode": { - "description": "mode for finding asin intersections optional field possible values: union, intersect; default value: intersect; learn more about the parameter in this help center guide", - "type": "string" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of products in the results array optional field default value: 100; maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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: [\"sum_position,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"intersections,desc\",\"avg_position,asc\"] default rule: [\"intersections,desc\"]", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "asins" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_product_rank_overview_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "asins": [ + "B001TJ3HUG", + "B01LW2SL7R" + ], + "language_name": "English", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "asins": [ + "B001TJ3HUG", + "B01LW2SL7R" + ], + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "asins": { + "description": "<em>product IDs to compare</em><br><strong>required field</strong><br>product IDs to receive ranking data for;<br><strong>the maximum number of ASINs you can specify in this array is 1000;</strong><br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a><p><strong>Note:</strong> all letters in ASIN code must be specified in uppercase format;<br>example:<br><code>B01LW2SL7R</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "asins": { - "description": "product IDs to compare required field product IDs to receive ranking data for; the maximum number of ASINs you can specify in this array is 1000; you can receive the asin parameter by making a separate request to the Amazon Products endpoint Note: all letters in ASIN code must be specified in uppercase format; example: B01LW2SL7R", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "asins" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_ranked_keywords_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "asin": "B00R92CL5E", + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "asin": "B00R92CL5E", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "asin": { + "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", + "type": "string" + }, + "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>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>[\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]</code>;<p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "asin": { - "description": "product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint", - "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, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: [\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of products in the results array optional field default value: 100; maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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: [\"keyword_data.keyword_info.competition,desc\"] default rule: [\"ranked_serp_element.serp_item.rank_group,asc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "asin" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_related_keywords_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "include_seed_keyword": true, + "keyword": "computer mouse", + "language_name": "English", + "limit": 5, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "include_seed_keyword": true, + "keyword": "computer mouse", + "language_name": "English", + "limit": 5, + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code>;<br>number of the returned results depends on the value you set in this field;<br>you can specify a level from 0 to 4;<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 6 keywords<br>2 – 42 keywords<br>3 – 258 keywords<br>4 – 1554 keywords", + "type": [ + "integer", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords should be specified in the lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "keyword search depth optional field default value: 1; number of the returned results depends on the value you set in this field; you can specify a level from 0 to 4; estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 6 keywords 2 – 42 keywords 3 – 258 keywords 4 – 1554 keywords", - "type": "integer" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen", - "type": "boolean" - }, - "include_seed_keyword": { - "description": "include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false", - "type": "boolean" - }, - "keyword": { - "description": "keyword required field UTF-8 encoding the keywords should be specified in the lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_apple_app_competitors_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.app_store_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_id": { - "description": "id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320", - "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: , , >, >=, =, , in, not_in example: [\"intersections\",\">\",500] [[\"competitor_metrics.app_store_search_organic.pos_1\",\"\",10],\"and\",[\"avg_position\",\">=\",\"10\"]] [[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]], \"or\", [\"sum_position\",\">=\",\"10000\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"intersections,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersections,desc\",\"sum_position,asc\"] default rule: [\"intersections,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_apple_app_intersection_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the ids should be specified the following way:<br>`\"app_ids\": {<br>\"1\": \"686449807\",<br>\"2\": \"382617920\"<br>}`<br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", + "type": [ + "object", + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_ids": { - "additionalProperties": { - "type": "string" - }, - "description": "ids of the target apps required field IDs of the target mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; the ids should be specified the following way: \"app_ids\": { \"1\": \"686449807\", \"2\": \"382617920\" } if you specify a single ID here, the API will return results only for one application; the maximum number of app IDs you can specify in this object is 20", - "type": "object" - }, - "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"intersection_result.382617920.rank_absolute,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_ids" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_apple_bulk_app_metrics_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_ids": [ + "686449807", + "382617920" + ], + "language_name": "English", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_ids": [ + "686449807", + "382617920" + ], + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "description": "<em>ids of the apps</em><br><strong>required field</strong><br>IDs of mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_ids": { - "description": "ids of the apps required field IDs of mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; the maximum number of IDs you can specify in this field is 1000", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_ids" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_apple_keywords_for_app_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_id": { - "description": "id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320", - "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"ranked_serp_element.serp_item.rank_group,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_app_competitors_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.google_play_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_id": { - "description": "id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger", - "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: , , >, >=, =, , in, not_in example: [\"intersections\",\">\",500] [[\"competitor_metrics.google_play_search_organic.pos_1\",\"\",10],\"and\",[\"avg_position\",\">=\",\"10\"]] [[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]], \"or\", [\"sum_position\",\">=\",\"10000\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"intersections,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersections,desc\",\"sum_position,asc\"] default rule: [\"intersections,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_app_intersection_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;;<br>the ids should be specified the following way:<br><code>\"app_ids\": {<br>\"1\": \"org.telegram.messenger\",<br>\"2\": \"com.zhiliaoapp.musically\"<br>}</code><br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", + "type": [ + "object", + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_ids": { - "additionalProperties": { - "type": "string" - }, - "description": "ids of the target apps required field IDs of the target mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger;; the ids should be specified the following way: \"app_ids\": { \"1\": \"org.telegram.messenger\", \"2\": \"com.zhiliaoapp.musically\" } if you specify a single ID here, the API will return results only for one application; the maximum number of app IDs you can specify in this object is 20", - "type": "object" - }, - "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"intersection_result.382617920.rank_absolute,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_ids" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_bulk_app_metrics_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_ids": [ + "org.telegram.messenger", + "com.zhiliaoapp.musically" + ], + "language_name": "English", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_ids": [ + "org.telegram.messenger", + "com.zhiliaoapp.musically" + ], + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "description": "<em>ids of the app</em><br><strong>required field</strong><br>IDs of the mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_ids": { - "description": "ids of the app required field IDs of the mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger; the maximum number of IDs you can specify in this field is 1000", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_ids" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_bulk_keyword_difficulty_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_bulk_traffic_estimation_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } + ], + "properties": { + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" + ] + }, + "targets": { + "description": "<em>target domains, subdomains, and webpages</em><br><strong>required field</strong><br>you can specify domains, subdomains, and webpages in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>pages should be specified with absolute URL, including <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains, subdomains or webpages", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code if you use this field, you don’t have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location if you use this field, you don’t have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "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" - }, - "targets": { - "description": "target domains, subdomains, and webpages required field you can specify domains, subdomains, and webpages in this field; domains and subdomains should be specified without https:// and www.; pages should be specified with absolute URL, including https:// and www.; you can set up to 1000 domains, subdomains or webpages", - "items": { - "type": "string" - }, - "type": "array" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "targets" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_categories_for_domain_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "item_types": [ + "paid", + "organic", + "featured_snippet", + "local_pack" + ], + "language_code": "en", + "limit": 3, + "location_name": "United States", + "target": "dataforseo.com" + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "item_types": [ + "paid", + "organic", + "featured_snippet", + "local_pack" + ], + "language_code": "en", + "limit": 3, + "location_name": "United States", + "target": "dataforseo.com" + } + ], + "properties": { + "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><br>example:<br><code>[\"metrics.organic.pos_1,\">\",0]</code><p><code>[[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]],<br>\"or\",<br>[\"metrics.organic.etv\",\"in\",[10,100]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and_<code>clickstream_age_distribution</code>_fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>n", + "type": [ + "boolean", + "null" + ] + }, + "include_subcategories": { + "description": "<em>indicates if the subcategories will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subcategories will be ignored<br>default value: <code>false</code><br>learn more about the parameter in this <a href=\"https://dataforseo.com/help-center/include_subcategories-in-categories-for-domain-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned categories</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned categories </em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain or subdomain</em><br><strong>required field</strong><br>the domain or subdomain name of the target website<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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 example: [\"metrics.organic.pos_1,\">\",0] [[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]], \"or\", [\"metrics.organic.etv\",\"in\",[10,100]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "historical_serp_mode": { - "description": "data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live", - "type": "string" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to_true, you will receive clickstream_etv, clickstream_gender_distribution, and_clickstream_age_distribution_fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article n", - "type": "boolean" - }, - "include_subcategories": { - "description": "indicates if the subcategories will be included in the search optional field if set to false, the subcategories will be ignored default value: false learn more about the parameter in this help center article", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned categories optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned categories optional field default value: 0 if you specify the 10 value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", - "type": "integer" - }, - "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 specify a sorting type example: [\"metrics.paid.etv,asc\"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"] default rule: [\"metrics.organic.count,desc\"] Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array", - "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" - }, - "target": { - "description": "domain or subdomain required field the domain or subdomain name of the target website the domain or subdomain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_categories_for_kw_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en" + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en" + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">English</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages example: English", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_domain_rank_overview_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } + ], + "properties": { + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms<br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned results for domain</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned items</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten <code>items</code> in the results array will be omitted and the data will be provided for the successive items", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value: falsen", - "type": "boolean" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned results for domain optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items", - "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" - }, - "target": { - "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_historical_bulk_traffic_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } + ], + "properties": { + "date_from": { + "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 12 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", + "type": [ + "string", + "null" + ] + }, + "date_to": { + "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response;<br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array;<br>possible values:<br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value:<br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" + ] + }, + "targets": { + "description": "<em>target domains and subdomains</em><br><strong>required field</strong><br>you can specify domains and subdomains in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains or subdomains", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "date_from": { - "description": "starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 12 months minimal possible value: 2020-10-01 date format: \"yyyy-mm-dd\"", - "type": "string" - }, - "date_to": { - "description": "ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default; date format: \"yyyy-mm-dd\" example: \"2021-04-01\"", - "type": "string" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response; Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code if you use this field, you don’t have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location if you use this field, you don’t have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "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" - }, - "targets": { - "description": "target domains and subdomains required field you can specify domains and subdomains in this field; domains and subdomains should be specified without https:// and www.; you can set up to 1000 domains or subdomains", - "items": { - "type": "string" - }, - "type": "array" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "targets" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_historical_keyword_data_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_historical_rank_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "language_code": "en", + "location_code": 2840, + "target": "dataforseo.com" + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "language_code": "en", + "location_code": 2840, + "target": "dataforseo.com" + } + ], + "properties": { + "correlate": { + "description": "<em>correlate data with previously obtained datasets</em><br>optional field<br>default value: <code>true</code><br>if you use this parameter, our system will correlate data you obtain now with previously obtained datasets<br>this parameter is intended to mitigate any inconsistencies that may result from changes to our database<br>we recommend always setting <code>correlate</code> to <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "date_from": { + "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 6 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", + "type": [ + "string", + "null" + ] + }, + "date_to": { + "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response;<br>default value: <code>false</code>;<p><strong>Note:</strong> historical clickstream data is available from 2024/05 (May, 2024);<br><strong>with this parameter enabled, you will be charged double the price for the request;</strong><br>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "correlate": { - "description": "correlate data with previously obtained datasets optional field default value: true if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any inconsistencies that may result from changes to our database we recommend always setting correlate to true", - "type": "boolean" - }, - "date_from": { - "description": "starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 6 months minimal possible value: 2020-10-01 date format: \"yyyy-mm-dd\"", - "type": "string" - }, - "date_to": { - "description": "ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: \"yyyy-mm-dd\" example: \"2021-04-01\"", - "type": "string" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response; default value: false; Note: historical clickstream data is available from 2024/05 (May, 2024); with this parameter enabled, you will be charged double the price for the request; learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "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" - }, - "target": { - "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keyword_ideas_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "include_serp_info": true, + "keywords": [ + "phone", + "watch" + ], + "language_code": "en", + "limit": 3, + "location_code": 2840 + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "allOf": [ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - } - ], - "required": [ - "keywords" - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "include_serp_info": true, + "keywords": [ + "phone", + "watch" + ], + "language_code": "en", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "closely_variants": { + "description": "<em>search mode</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> the results will be based on the phrase-match search algorithm<br>if set to <code class=\"prettyprint\">false</code> the results will be based on the broad-match search algorithm<br>default value: <code>false</code>n", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>The maximum number of keywords you can specify: 200.<br>The keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>700</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<p><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>[\"relevance,desc\",\"keyword_info.search_volume,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "closely_variants": { - "description": "search mode optional field if set to_true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: falsen", - "type": "boolean" - }, - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "keywords": { - "description": "keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. The keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "limit": { - "description": "the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 default rule: [\"relevance,desc\"] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint. note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"relevance,desc\",\"keyword_info.search_volume,desc\"]", - "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" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keyword_overview_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "include_clickstream_data": true, + "include_serp_info": true, + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "include_clickstream_data": true, + "include_serp_info": true, + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "keywords": { - "description": "keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keyword_suggestions_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "include_seed_keyword": true, + "include_serp_info": true, + "keyword": "phone", + "language_code": "en", + "limit": 1, + "location_code": 2840 + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "required": [ - "keyword" - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "include_seed_keyword": true, + "include_serp_info": true, + "keyword": "phone", + "language_code": "en", + "limit": 1, + "location_code": 2840 + } + ], + "properties": { + "exact_match": { + "description": "<em>search for the exact phrase</em><br>optional field<br>if set to <code>true</code>, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase<br>default value: <code>false</code>", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format;<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>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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>a comma is used as a separator<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "exact_match": { - "description": "search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: false", - "type": "boolean" - }, - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_seed_keyword": { - "description": "include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "keyword": { - "description": "keyword required field UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 a comma is used as a separator example: [\"keyword_info.competition,desc\"] default rule: [\"keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]", - "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" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keywords_for_app_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the apps</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_id": { - "description": "id of the apps required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger", - "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"ranked_serp_element.serp_item.rank_group,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keywords_for_categories_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "category_codes": [ + "12191", + "12193" + ], + "include_serp_info": true, + "language_name": "English", + "limit": 3, + "location_code": 2840 + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "allOf": [ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } - ], - "required": [ - "category_codes" - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "category_codes": [ + "12191", + "12193" + ], + "include_serp_info": true, + "language_name": "English", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "category_codes": { + "description": "<em>product and service categories</em><br><strong>required field</strong><br>The maximum number of categories you can specify: 20<br>you can download <a href=\"https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv\">the full list of possible categories</a>", + "items": { + "type": "string" + }, + "type": "array" + }, + "category_intersection": { + "description": "<em>category intersections</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, you will get keywords featured in all specified categories;<br>if set to <code class=\"prettyprint\">false</code>, you will keywords that are specified in any of the specified categories;<br>default value: <code>true</code>", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "category_codes": { - "description": "product and service categories required field The maximum number of categories you can specify: 20 you can download the full list of possible categories", - "items": { - "type": "integer" - }, - "type": "array" - }, - "category_intersection": { - "description": "category intersections optional field if set to true, you will get keywords featured in all specified categories; if set to false, you will keywords that are specified in any of the specified categories; default value: true", - "type": "boolean" - }, - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "language_code": { - "description": "unique language identifier required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 type example: [\"keyword_info.competition,desc\"] default rule: [\"keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]", - "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" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_kw_for_site_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "filters": [ + "serp_info.se_results_count", + ">", + 0 + ], + "include_serp_info": true, + "include_subdomains": true, + "language_code": "en", + "limit": 3, + "location_code": 2840, + "target": "apple.com" + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "allOf": [ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - } - ], - "required": [ - "target" - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "filters": [ + "serp_info.se_results_count", + ">", + 0 + ], + "include_serp_info": true, + "include_subdomains": true, + "language_code": "en", + "limit": 3, + "location_code": 2840, + "target": "apple.com" + } + ], + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_subdomains": { + "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<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>[\"relevance,desc\",\"keyword_info.search_volume,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" + ] + }, + "target": { + "description": "<em>domain name or page url</em><br><strong>required field</strong><br>the domain name of the target website, subdomain or URL of the target webpage;<br>the <strong>domain name</strong> must be specified <strong>without</strong> <code>https://</code> or <code>www.</code>;<br>the <strong>subdomain</strong> must be specified <strong>without</strong> <code>https://</code>;<br>the <strong>webpage URL</strong> must be specified <strong>with</strong> <code>https://</code> or <code>www.</code><br><strong>Note:</strong> if you specify the <strong>webpage URL</strong> without <code>https://</code> or <code>www.</code>, the result will be returned for the <strong>entire domain</strong> rather than the specific page", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: [\"keyword_info.search_volume\",\">\",0] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to_true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article n\"", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "include_subdomains": { - "description": "indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true", - "type": "boolean" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "limit": { - "description": "the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 default rule: [\"relevance,desc\"] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"relevance,desc\",\"keyword_info.search_volume,desc\"]", - "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" - }, - "target": { - "description": "target domain required field the domain name of the target website the domain should be specified without https://", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_related_keywords_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "phone", + "language_name": "English", + "limit": 3, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "phone", + "language_name": "English", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code><p>number of the returned results depends on the value you set in this field<br>you can specify a level from 0 to 4<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 8 keywords<br>2 – 72 keywords<br>3 – 584 keywords<br>4 – 4680 keywords", + "type": [ + "integer", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_data.keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 type<br>example:<br><code>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "replace_with_core_keyword": { + "description": "<em>return data for core keyword</em><br>optional field<br>if <code>true</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the main keyword in the group that the specified <code>keyword</code> belongs to;<br>if <code>false</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the specified <code>keyword</code> (if available);<br>refer to <a href=\"https://dataforseo.com/help-center/replace_with_core_keyword\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a> for more details;<br>default value: <code>false</code>", + "type": [ + "boolean", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "keyword search depth optional field default value: 1 number of the returned results depends on the value you set in this field you can specify a level from 0 to 4 estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 8 keywords 2 – 72 keywords 3 – 584 keywords 4 – 4680 keywords", - "type": "integer" - }, - "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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_data.keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_data.keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_data.keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_seed_keyword": { - "description": "include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "keyword": { - "description": "keyword required field UTF-8 encoding the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 type example: [\"keyword_data.keyword_info.competition,desc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "replace_with_core_keyword": { - "description": "return data for core keyword optional field if true, serp_info and related_keywords will be returned for the main keyword in the group that the specified keyword belongs to; if false, serp_info and related_keywords will be returned for the specified keyword (if available); refer to this help center article for more details; default value: false", - "type": "boolean" - }, - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_relevant_pages_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "limit": 3, + "location_code": 2840, + "target": "amazon.com" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "limit": 3, + "location_code": 2840, + "target": "amazon.com" + } + ], + "properties": { + "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><p>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]]</code><p><code>[[\"\"metrics.organic.count\",\">\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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 example: [\"metrics.paid.count\",\">\",0] [[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"\",0]] [[\"\"metrics.organic.count\",\">\",50\"], \"and\", [[\"metrics.organic.pos_1\",\"\",0],\"or\",[\"metrics.organic.pos_2_3\",\"\",0]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "historical_serp_mode": { - "description": "data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live", - "type": "string" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned pages optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned pages optional field default value: 0 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", - "type": "integer" - }, - "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 specify a sorting type example: [\"metrics.paid.etv,asc\"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"] default rule: [\"metrics.organic.count,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - }, - "target": { - "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_search_intent_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "login page", + "audi a7", + "elon musk", + "milk store new york" + ] + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "login page", + "audi a7", + "elon musk", + "milk store new york" + ] + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these languages only; example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports the following languages only: Arabic, ar, Chinese(Traditional), zh-TW, Czech, cs, Danish, da, Dutch, nl, English, en, Finnish, fi, French, fr, German, de, Hebrew, he, Hindi, hi, Italian, it, Japanese, ja, Korean, ko, Malay, ms, Norwegian(Bokmål), nb, Polish, pl, Portuguese, pt, Romanian, ro, Russian, ru, Spanish, es, Swedish, sv, Thai, th, Ukrainian, uk, Vietnamese, vi, Bulgarian, bg, Croatian, hr, Serbian, sr, Slovenian, sl, Bosnian, bs, Greek, el, Hungarian, hu, Slovak, sk, Turkish, tr example: English", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_serp_competitors_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "item_types": [ + "organic" + ], + "keywords": [ + "phone" + ], + "language_name": "English", + "limit": 5, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "item_types": [ + "organic" + ], + "keywords": [ + "phone" + ], + "language_name": "English", + "limit": 5, + "location_code": 2840 + } + ], + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"median_position\",\"in\",[1,10]]</code><p><code>[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]</code><p><code>[[\"domain\",\"not_like\",\"%wikipedia.org%\"],<br>\"and\",<br>[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "include_subdomains": { + "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>search results type</em><br>indicates type of search results included in the response<br>optional field<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "keywords": { + "description": "<em>keywords array</em><br><strong>required field</strong><br>the results will be based on the keywords you specify in this array<br>UTF-8 encoding;<br>the keywords will be converted to lowercase format;<br><strong>you can specify the maximum of 200 keywords</strong><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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with <code>location_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", + "type": [ + "integer", + "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>the comma is used as a separator<br>example:<br><code>[\"avg_position,asc\"]</code><br>default rule:<br><code>[\"rating,desc\"]</code><br><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>[\"avg_position,asc\",\"etv,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"median_position\",\"in\",[1,10]] [[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]] [[\"domain\",\"not_like\",\"%wikipedia.org%\"], \"and\", [[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "include_subdomains": { - "description": "indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true", - "type": "boolean" - }, - "item_types": { - "description": "search results type indicates type of search results included in the response optional field possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "keywords": { - "description": "keywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; you can specify the maximum of 200 keywords learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "unique language identifier required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned domains optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with location_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", - "type": "integer" - }, - "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 the comma is used as a separator example: [\"avg_position,asc\"] default rule: [\"rating,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"avg_position,asc\",\"etv,desc\"]", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_subdomains_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } + ], + "properties": { + "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><br>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]]</code><p><code>[[\"metrics.organic.count\",\">\",\"10\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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 example: [\"metrics.paid.count\",\">\",0] [[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]] [[\"metrics.organic.count\",\">\",\"10\"], \"and\", [[\"metrics.organic.pos_1\",\"\",0],\"or\",[\"metrics.organic.pos_2_3\",\"\",0]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "historical_serp_mode": { - "description": "data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live", - "type": "string" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type example: [\"metrics.paid.etv,asc\"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"] default rule: [\"metrics.organic.count,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - }, - "target": { - "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_top_searches_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_name": "English", + "limit": 3, + "location_code": 2840 + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "allOf": [ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "language_name": "English", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like,as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request default value: 1000 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 type example: [\"keyword_info.competition,desc\"] default rule: [\"keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]", - "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" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
search17 fields changed- added
Input schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - removed
Input schema / properties / category / anyOfRemoved value: -[ - { - "enum": [ - "seo", - "finance", - "social", - "search", - "sales", - "mail" - ], - "type": "string" - }, - { - "type": "null" - } -] - removed
Input schema / properties / category / defaultRemoved value: -null - changed
Input 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.)" - added
Input schema / properties / category / enumAdded value: +[ + "seo", + "finance", + "social", + "search", + "sales", + "mail" +] - added
Input schema / properties / category / typeAdded value: +"string" - added
Input schema / properties / known_fieldsAdded value: +{ + "additionalProperties": true, + "default": {}, + "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.", + "type": "object" +} - changed
Input schema / properties / limit / descriptionPrevious value: -"Maximum candidates, 1-10"New value: +"Maximum number of additional direct tool candidates." - added
Input schema / properties / limit / maximumAdded value: +20 - added
Input schema / properties / limit / minimumAdded value: +1 - added
Input 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 +} - changed
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." - added
Input schema / properties / query / maxLengthAdded value: +2000 - added
Input schema / properties / query / minLengthAdded value: +1 - added
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" +} - added
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" + } + } +} - added
Output schema / requiredAdded value: +[ + "next_steps_guidance", + "search_id", + "session_id", + "tools" +]
- Changed
use1 field changed- changed
Input 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"
52 tool updates
- Removed
batch_get_schema - Removed
batch_quote - Changed
batch_use18 fields changed- removed
Input schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - added
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" - removed
Input schema / properties / calls / items / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - changed
Input schema / properties / calls / items / additionalPropertiesPrevious value: -falseNew value: +true - removed
Input 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" - } -} - removed
Input schema / properties / calls / items / requiredRemoved value: -[ - "call_id", - "tool", - "arguments" -] - removed
Input schema / properties / calls / maxItemsRemoved value: -20 - removed
Input schema / properties / calls / minItemsRemoved value: -1 - added
Input schema / properties / max_price_usdAdded value: +{ + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "default": null, + "description": "Per-call price cap applied to every item" +} - added
Input schema / properties / search_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - added
Input schema / properties / search_id / defaultAdded value: +null - changed
Input schema / properties / search_id / descriptionPrevious value: -"Optional search correlation identifier returned by search."New value: +"search_id from the search that found these operations" - removed
Input schema / properties / search_id / typeRemoved value: -"string" - removed
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" -} - removed
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." - } -} - removed
Output schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - removed
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" - } -} - removed
Output schema / requiredRemoved value: -[ - "session_id", - "batch_id", - "total_count", - "success_count", - "error_count", - "results", - "next_steps_guidance" -]
- Changed
get_ahrefs_domain_rating2 fields changed- removed
Input schema / properties / target / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "date", - "target" -]New value: +[ + "target", + "date" +]
- Changed
get_ahrefs_site_metrics2 fields changed- removed
Input schema / properties / target / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "date", - "target" -]New value: +[ + "target", + "date" +]
- Changed
get_dataforseo_labs_available_filters1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_labs_google_available_history1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_labs_google_categories_for_kw_languages1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_labs_status1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_details13 fields changed- removed
Input schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - added
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." +} - removed
Input schema / properties / include_arguments_schemaRemoved value: -{ - "default": true, - "description": "Return the complete arguments_schema. Defaults to true.", - "type": "boolean" -} - changed
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." - removed
Input schema / properties / include_response_schemaRemoved value: -{ - "default": false, - "description": "Return the complete response_schema. Defaults to false.", - "type": "boolean" -} - added
Input schema / properties / operation_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "description": "One operation_id from search" +} - added
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" +} - removed
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" -} - removed
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 -} - added
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" +} - removed
Input schema / requiredRemoved value: -[ - "tools" -] - removed
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" - } -} - removed
Output schema / requiredRemoved value: -[ - "error_count", - "next_steps_guidance", - "session_id", - "success_count", - "tools", - "total_count" -]
- Changed
get_semrush_domain_organic_keywords5 fields changed- added
Input schema / properties / database / descriptionAdded value: +"Regional database / country code, e.g. `us`." - added
Input schema / properties / database / exampleAdded value: +"us" - added
Input schema / properties / domain / descriptionAdded value: +"Target domain, e.g. `ahrefs.com`." - added
Input schema / properties / domain / exampleAdded value: +"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "database", - "domain" -]New value: +[ + "domain", + "database" +]
- Changed
get_semrush_domain_overview2 fields changed- added
Input schema / properties / database / descriptionAdded value: +"Regional database / country code. Defaults to `us`. Examples: `us`, `uk`, `cn`." - added
Input schema / properties / domain / descriptionAdded value: +"Target domain, e.g. `ahrefs.com`."
- Changed
get_semrush_domain_paid_keywords5 fields changed- added
Input schema / properties / database / descriptionAdded value: +"Regional database / country code, e.g. `us`." - added
Input schema / properties / database / exampleAdded value: +"us" - added
Input schema / properties / domain / descriptionAdded value: +"Target domain, e.g. `ahrefs.com`." - added
Input schema / properties / domain / exampleAdded value: +"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "database", - "domain" -]New value: +[ + "domain", + "database" +]
- Changed
get_semrush_domain_rank_history5 fields changed- added
Input schema / properties / database / descriptionAdded value: +"Regional database / country code, e.g. `us`." - added
Input schema / properties / database / exampleAdded value: +"us" - added
Input schema / properties / domain / descriptionAdded value: +"Target domain, e.g. `ahrefs.com`." - added
Input schema / properties / domain / exampleAdded value: +"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "database", - "domain" -]New value: +[ + "domain", + "database" +]
- Changed
get_semrush_domain_vs_domain5 fields changed- added
Input schema / properties / database / descriptionAdded value: +"Regional database / country code, e.g. `us`." - added
Input schema / properties / database / exampleAdded value: +"us" - added
Input schema / properties / domains / descriptionAdded value: +"Comparison spec: `sign|type|domain` groups joined by `|` (sign in + - * /, type in `or`/`ad`). Example: `+|or|ahrefs.com|+|or|semrush.com`." - added
Input schema / properties / domains / exampleAdded value: +"+|or|ahrefs.com|+|or|semrush.com" - changed
Input schema / requiredPrevious value: -[ - "database", - "domains" -]New value: +[ + "domains", + "database" +]
- Changed
get_semrush_organic_competitors5 fields changed- added
Input schema / properties / database / descriptionAdded value: +"Regional database / country code, e.g. `us`." - added
Input schema / properties / database / exampleAdded value: +"us" - added
Input schema / properties / domain / descriptionAdded value: +"Target domain, e.g. `ahrefs.com`." - added
Input schema / properties / domain / exampleAdded value: +"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "database", - "domain" -]New value: +[ + "domain", + "database" +]
- Changed
get_semrush_url_organic_keywords5 fields changed- added
Input schema / properties / database / descriptionAdded value: +"Regional database / country code, e.g. `us`." - added
Input schema / properties / database / exampleAdded value: +"us" - added
Input schema / properties / url / descriptionAdded value: +"Target URL (landing page)." - added
Input schema / properties / url / exampleAdded value: +"https://ahrefs.com/blog/" - changed
Input schema / requiredPrevious value: -[ - "database", - "url" -]New value: +[ + "url", + "database" +]
- Changed
post_dataforseo_labs_amazon_bulk_volume_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keywords": [ - "buy laptop", - "cheap laptops for sale", - "purchase laptop" - ], - "language_code": "en", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "buy laptop", - "cheap laptops for sale", - "purchase laptop" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><a name=\"loc\"></a><br><strong>Note:</strong> this endpoint currently supports the following locations and languages only:<p><code>Australia</code> - <code>2036</code>, <code>en</code><br><code>Austria</code> - <code>2040</code>, <code>de</code><br><code>Canada</code> - <code>2124</code>, <code>en</code><br><code>Egypt</code> - <code>2818</code>, <code>ar</code><br><code>France</code> - <code>2250</code>, <code>fr</code><br><code>Germany</code> - <code>2276</code>, <code>de</code><br><code>India</code> - <code>2356</code>, <code>en</code><br><code>Italy</code> - <code>2380</code>, <code>it</code><br><code>Mexico</code> - <code>2484</code>, <code>es</code><br><code>Netherlands</code> - <code>2528</code>, <code>nl</code><br><code>Saudi Arabia</code> - <code>2682</code>, <code>ar</code><br><code>Singapore</code> - <code>2702</code>, <code>en</code><br><code>Spain</code> - <code>2724</code>, <code>es</code><br><code>United Arab Emirates</code> - <code>2784</code>, <code>ar</code><br><code>United Kingdom</code> - <code>2826</code>, <code>en</code><br><code>United States</code> - <code>2840</code>, <code>en</code><br>example:<br><code class=\"long-string\">United States</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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "keywords": { + "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these locations and languages only; example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these locations and languages only; example: English", + "type": "string" + }, + "location_code": { + "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports these locations and languages only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the following locations and languages only: Australia – 2036, en Austria – 2040, de Canada – 2124, en Egypt – 2818, ar France – 2250, fr Germany – 2276, de India – 2356, en Italy – 2380, it Mexico – 2484, es Netherlands – 2528, nl Saudi Arabia – 2682, ar Singapore – 2702, en Spain – 2724, es United Arab Emirates – 2784, ar United Kingdom – 2826, en United States – 2840, en example: United States", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keywords" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_amazon_product_competitors_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "asin": "019005476X", - "language_code": "en", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "asin": "019005476X", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "asin": { - "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", - "type": "string" - }, - "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"full_metrics.amazon_serp.pos_1\",\">\", 20]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned product competitors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", - "type": [ - "integer", - "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>[\"full_metrics.amazon_serp.pos_1,desc\"]</code><br><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>[\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "asin": { + "description": "product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint", + "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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"full_metrics.amazon_serp.pos_1\",\">\", 20] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "language_code": { + "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of products in the results array optional field default value: 100; maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned product competitors optional field default value: 0 if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", + "type": "integer" + }, + "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: [\"full_metrics.amazon_serp.pos_1,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"] default rule: [\"ranked_serp_element.serp_item.rank_group,asc\"]", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "asin" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_amazon_product_kw_overlap_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "asins": { - "1": "B09172433Z", - "2": "B07GBZ4Q68", - "3": "B07GCKQD77" - }, - "language_name": "English", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "asins": { - "1": "B09172433Z", - "2": "B07GBZ4Q68", - "3": "B07GCKQD77" - }, - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "asins": { - "additionalProperties": { - "type": [ - "string", - "null" - ] - }, - "description": "<em>asins of target products</em><br><strong>required field</strong><br>product IDs of the products for which you need to find keyword intersections;<br>specify the ASINs as in the following example:<br><code>\"asins\": {<br>\"1\": \"019005476X\",<br>\"2\": \"0190074442\"<br>}</code><br><strong>the maximum number of ASINs you can specify in this object is 20;</strong><br>learn more about the parameter on <a href=\"https://dataforseo.com/help-center/how-to-get-amazon-product-data-using-asin\" rel=\"noopener noreferrer\" target=\"_blank\">this help center page</a>", - "type": [ - "object", - "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"avg_position\",\"<\", 10]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "intersection_mode": { - "description": "<em>mode for finding asin intersections</em><br>optional field<br>possible values: <code>union</code>, <code>intersect</code>;<br>default value: <code>intersect</code>;<br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/what-is-intersection-mode-in-amazon-keyword-intersections-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>", - "type": [ - "string", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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>[\"sum_position,desc\"]</code><br><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>[\"intersections,desc\",\"avg_position,asc\"]</code><br>default rule:<br><code>[\"intersections,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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "asins": { + "additionalProperties": { + "type": "string" + }, + "description": "asins of target products required field product IDs of the products for which you need to find keyword intersections; specify the ASINs as in the following example: \"asins\": { \"1\": \"019005476X\", \"2\": \"0190074442\" } the maximum number of ASINs you can specify in this object is 20; learn more about the parameter on this help center page", + "type": "object" + }, + "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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"avg_position\",\"<\", 10] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", + "items": {}, + "type": "array" + }, + "intersection_mode": { + "description": "mode for finding asin intersections optional field possible values: union, intersect; default value: intersect; learn more about the parameter in this help center guide", + "type": "string" + }, + "language_code": { + "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of products in the results array optional field default value: 100; maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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: [\"sum_position,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"intersections,desc\",\"avg_position,asc\"] default rule: [\"intersections,desc\"]", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "asins" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_amazon_product_rank_overview_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "asins": [ - "B001TJ3HUG", - "B01LW2SL7R" - ], - "language_name": "English", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "asins": [ - "B001TJ3HUG", - "B01LW2SL7R" - ], - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "asins": { - "description": "<em>product IDs to compare</em><br><strong>required field</strong><br>product IDs to receive ranking data for;<br><strong>the maximum number of ASINs you can specify in this array is 1000;</strong><br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a><p><strong>Note:</strong> all letters in ASIN code must be specified in uppercase format;<br>example:<br><code>B01LW2SL7R</code>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "asins": { + "description": "product IDs to compare required field product IDs to receive ranking data for; the maximum number of ASINs you can specify in this array is 1000; you can receive the asin parameter by making a separate request to the Amazon Products endpoint Note: all letters in ASIN code must be specified in uppercase format; example: B01LW2SL7R", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "location_code": { + "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "asins" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_amazon_ranked_keywords_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "asin": "B00R92CL5E", - "language_code": "en", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "asin": "B00R92CL5E", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "asin": { - "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", - "type": "string" - }, - "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>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>[\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]</code>;<p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "asin": { + "description": "product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint", + "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, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: [\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", + "type": "boolean" + }, + "language_code": { + "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of products in the results array optional field default value: 100; maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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: [\"keyword_data.keyword_info.competition,desc\"] default rule: [\"ranked_serp_element.serp_item.rank_group,asc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "asin" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_amazon_related_keywords_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "include_seed_keyword": true, - "keyword": "computer mouse", - "language_name": "English", - "limit": 5, - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "include_seed_keyword": true, - "keyword": "computer mouse", - "language_name": "English", - "limit": 5, - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code>;<br>number of the returned results depends on the value you set in this field;<br>you can specify a level from 0 to 4;<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 6 keywords<br>2 – 42 keywords<br>3 – 258 keywords<br>4 – 1554 keywords", - "type": [ - "integer", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "include_seed_keyword": { - "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords should be specified in the lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "depth": { + "description": "keyword search depth optional field default value: 1; number of the returned results depends on the value you set in this field; you can specify a level from 0 to 4; estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 6 keywords 2 – 42 keywords 3 – 258 keywords 4 – 1554 keywords", + "type": "integer" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen", + "type": "boolean" + }, + "include_seed_keyword": { + "description": "include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false", + "type": "boolean" + }, + "keyword": { + "description": "keyword required field UTF-8 encoding the keywords should be specified in the lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "type": "string" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_apple_app_competitors_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_id": "686449807", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "686449807", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.app_store_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "app_id": { + "description": "id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320", + "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: , , >, >=, =, , in, not_in example: [\"intersections\",\">\",500] [[\"competitor_metrics.app_store_search_organic.pos_1\",\"\",10],\"and\",[\"avg_position\",\">=\",\"10\"]] [[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]], \"or\", [\"sum_position\",\">=\",\"10000\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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 specify a sorting type; example: [\"intersections,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersections,desc\",\"sum_position,asc\"] default rule: [\"intersections,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_id" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_apple_app_intersection_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_ids": { - "1": "686449807", - "2": "382617920" - }, - "language_name": "English", - "limit": 10, - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_ids": { - "1": "686449807", - "2": "382617920" - }, - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "additionalProperties": { - "type": [ - "string", - "null" - ] - }, - "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the ids should be specified the following way:<br>`\"app_ids\": {<br>\"1\": \"686449807\",<br>\"2\": \"382617920\"<br>}`<br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", - "type": [ - "object", - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "app_ids": { + "additionalProperties": { + "type": "string" + }, + "description": "ids of the target apps required field IDs of the target mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; the ids should be specified the following way: \"app_ids\": { \"1\": \"686449807\", \"2\": \"382617920\" } if you specify a single ID here, the API will return results only for one application; the maximum number of app IDs you can specify in this object is 20", + "type": "object" + }, + "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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 specify a sorting type; example: [\"intersection_result.382617920.rank_absolute,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_ids" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_apple_bulk_app_metrics_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_ids": [ - "686449807", - "382617920" - ], - "language_name": "English", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_ids": [ - "686449807", - "382617920" - ], - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "description": "<em>ids of the apps</em><br><strong>required field</strong><br>IDs of mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "app_ids": { + "description": "ids of the apps required field IDs of mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; the maximum number of IDs you can specify in this field is 1000", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", + "type": "string" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_ids" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_apple_keywords_for_app_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_id": "686449807", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "686449807", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "app_id": { + "description": "id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320", + "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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 specify a sorting type; example: [\"ranked_serp_element.serp_item.rank_group,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_id" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_app_competitors_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_id": "org.telegram.messenger", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.google_play_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "app_id": { + "description": "id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger", + "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: , , >, >=, =, , in, not_in example: [\"intersections\",\">\",500] [[\"competitor_metrics.google_play_search_organic.pos_1\",\"\",10],\"and\",[\"avg_position\",\">=\",\"10\"]] [[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]], \"or\", [\"sum_position\",\">=\",\"10000\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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 specify a sorting type; example: [\"intersections,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersections,desc\",\"sum_position,asc\"] default rule: [\"intersections,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_id" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_app_intersection_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_ids": { - "1": "686449807", - "2": "382617920" - }, - "language_name": "English", - "limit": 10, - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_ids": { - "1": "686449807", - "2": "382617920" - }, - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "additionalProperties": { - "type": [ - "string", - "null" - ] - }, - "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;;<br>the ids should be specified the following way:<br><code>\"app_ids\": {<br>\"1\": \"org.telegram.messenger\",<br>\"2\": \"com.zhiliaoapp.musically\"<br>}</code><br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", - "type": [ - "object", - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "app_ids": { + "additionalProperties": { + "type": "string" + }, + "description": "ids of the target apps required field IDs of the target mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger;; the ids should be specified the following way: \"app_ids\": { \"1\": \"org.telegram.messenger\", \"2\": \"com.zhiliaoapp.musically\" } if you specify a single ID here, the API will return results only for one application; the maximum number of app IDs you can specify in this object is 20", + "type": "object" + }, + "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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 specify a sorting type; example: [\"intersection_result.382617920.rank_absolute,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_ids" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_bulk_app_metrics_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_ids": [ - "org.telegram.messenger", - "com.zhiliaoapp.musically" - ], - "language_name": "English", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_ids": [ - "org.telegram.messenger", - "com.zhiliaoapp.musically" - ], - "language_name": "English", - "location_code": 2840 - } - ], - "properties": { - "app_ids": { - "description": "<em>ids of the app</em><br><strong>required field</strong><br>IDs of the mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "app_ids": { + "description": "ids of the app required field IDs of the mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger; the maximum number of IDs you can specify in this field is 1000", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", + "type": "string" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_ids" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_bulk_keyword_difficulty_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keywords": [ - "dentist new york", - "pizza brooklyn", - "car dealer los angeles" - ], - "language_code": "en", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "dentist new york", - "pizza brooklyn", - "car dealer los angeles" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "keywords": { + "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "location_code": { + "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keywords" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_bulk_traffic_estimation_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "item_types": [ - "organic", - "paid" - ], - "language_code": "en", - "location_code": 2840, - "targets": [ - "dataforseo.com", - "cnn.com", - "forbes.com" - ] - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "item_types": [ - "organic", - "paid" - ], - "language_code": "en", - "location_code": 2840, - "targets": [ - "dataforseo.com", - "cnn.com", - "forbes.com" - ] - } - ], - "properties": { - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" - ] - }, - "targets": { - "description": "<em>target domains, subdomains, and webpages</em><br><strong>required field</strong><br>you can specify domains, subdomains, and webpages in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>pages should be specified with absolute URL, including <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains, subdomains or webpages", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to_true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false", + "type": "boolean" + }, + "item_types": { + "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", + "type": "string" + }, + "location_code": { + "description": "location code if you use this field, you don’t have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location if you use this field, you don’t have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", + "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" + }, + "targets": { + "description": "target domains, subdomains, and webpages required field you can specify domains, subdomains, and webpages in this field; domains and subdomains should be specified without https:// and www.; pages should be specified with absolute URL, including https:// and www.; you can set up to 1000 domains, subdomains or webpages", + "items": { + "type": "string" + }, + "type": "array" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "targets" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_categories_for_domain_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "item_types": [ - "paid", - "organic", - "featured_snippet", - "local_pack" - ], - "language_code": "en", - "limit": 3, - "location_name": "United States", - "target": "dataforseo.com" - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "item_types": [ - "paid", - "organic", - "featured_snippet", - "local_pack" - ], - "language_code": "en", - "limit": 3, - "location_name": "United States", - "target": "dataforseo.com" - } - ], - "properties": { - "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><br>example:<br><code>[\"metrics.organic.pos_1,\">\",0]</code><p><code>[[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]],<br>\"or\",<br>[\"metrics.organic.etv\",\"in\",[10,100]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "historical_serp_mode": { - "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", - "type": [ - "string", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and_<code>clickstream_age_distribution</code>_fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>n", - "type": [ - "boolean", - "null" - ] - }, - "include_subcategories": { - "description": "<em>indicates if the subcategories will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subcategories will be ignored<br>default value: <code>false</code><br>learn more about the parameter in this <a href=\"https://dataforseo.com/help-center/include_subcategories-in-categories-for-domain-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned categories</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned categories </em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", - "type": [ - "integer", - "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array", - "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" - ] - }, - "target": { - "description": "<em>domain or subdomain</em><br><strong>required field</strong><br>the domain or subdomain name of the target website<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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 example: [\"metrics.organic.pos_1,\">\",0] [[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]], \"or\", [\"metrics.organic.etv\",\"in\",[10,100]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "historical_serp_mode": { + "description": "data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live", + "type": "string" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to_true, you will receive clickstream_etv, clickstream_gender_distribution, and_clickstream_age_distribution_fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article n", + "type": "boolean" + }, + "include_subcategories": { + "description": "indicates if the subcategories will be included in the search optional field if set to false, the subcategories will be ignored default value: false learn more about the parameter in this help center article", + "type": "boolean" + }, + "item_types": { + "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned categories optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned categories optional field default value: 0 if you specify the 10 value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", + "type": "integer" + }, + "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 specify a sorting type example: [\"metrics.paid.etv,asc\"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"] default rule: [\"metrics.organic.count,desc\"] Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array", + "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" + }, + "target": { + "description": "domain or subdomain required field the domain or subdomain name of the target website the domain or subdomain should be specified without https:// and www.", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "target" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_categories_for_kw_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keywords": [ - "dentist new york", - "pizza brooklyn", - "car dealer los angeles" - ], - "language_code": "en" - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "dentist new york", - "pizza brooklyn", - "car dealer los angeles" - ], - "language_code": "en" - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">English</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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "keywords": { + "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages example: English", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keywords" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_domain_rank_overview_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "language_name": "English", - "location_code": 2840, - "target": "dataforseo.com" - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "language_name": "English", - "location_code": 2840, - "target": "dataforseo.com" - } - ], - "properties": { - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms<br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned results for domain</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned items</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten <code>items</code> in the results array will be omitted and the data will be provided for the successive items", - "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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to_true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value: falsen", + "type": "boolean" + }, + "language_code": { + "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned results for domain optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items", + "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" + }, + "target": { + "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "target" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_historical_bulk_traffic_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "date_from": "2021-01-01", - "date_to": "2021-03-29", - "item_types": [ - "organic", - "paid" - ], - "language_code": "en", - "location_code": 2840, - "targets": [ - "dataforseo.com", - "cnn.com", - "forbes.com" - ] - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "date_from": "2021-01-01", - "date_to": "2021-03-29", - "item_types": [ - "organic", - "paid" - ], - "language_code": "en", - "location_code": 2840, - "targets": [ - "dataforseo.com", - "cnn.com", - "forbes.com" - ] - } - ], - "properties": { - "date_from": { - "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 12 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", - "type": [ - "string", - "null" - ] - }, - "date_to": { - "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response;<br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array;<br>possible values:<br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value:<br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" - ] - }, - "targets": { - "description": "<em>target domains and subdomains</em><br><strong>required field</strong><br>you can specify domains and subdomains in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains or subdomains", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "date_from": { + "description": "starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 12 months minimal possible value: 2020-10-01 date format: \"yyyy-mm-dd\"", + "type": "string" + }, + "date_to": { + "description": "ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default; date format: \"yyyy-mm-dd\" example: \"2021-04-01\"", + "type": "string" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen", + "type": "boolean" + }, + "item_types": { + "description": "display results by item type optional field indicates the type of search results included in the response; Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", + "type": "string" + }, + "location_code": { + "description": "location code if you use this field, you don’t have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location if you use this field, you don’t have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", + "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" + }, + "targets": { + "description": "target domains and subdomains required field you can specify domains and subdomains in this field; domains and subdomains should be specified without https:// and www.; you can set up to 1000 domains or subdomains", + "items": { + "type": "string" + }, + "type": "array" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "targets" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_historical_keyword_data_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keywords": [ - "iphone" - ], - "language_code": "en", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "iphone" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "keywords": { - "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "keywords": { + "description": "keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keywords" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_historical_rank_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "date_from": "2021-01-01", - "date_to": "2021-03-29", - "language_code": "en", - "location_code": 2840, - "target": "dataforseo.com" - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "date_from": "2021-01-01", - "date_to": "2021-03-29", - "language_code": "en", - "location_code": 2840, - "target": "dataforseo.com" - } - ], - "properties": { - "correlate": { - "description": "<em>correlate data with previously obtained datasets</em><br>optional field<br>default value: <code>true</code><br>if you use this parameter, our system will correlate data you obtain now with previously obtained datasets<br>this parameter is intended to mitigate any inconsistencies that may result from changes to our database<br>we recommend always setting <code>correlate</code> to <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "date_from": { - "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 6 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", - "type": [ - "string", - "null" - ] - }, - "date_to": { - "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response;<br>default value: <code>false</code>;<p><strong>Note:</strong> historical clickstream data is available from 2024/05 (May, 2024);<br><strong>with this parameter enabled, you will be charged double the price for the request;</strong><br>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "correlate": { + "description": "correlate data with previously obtained datasets optional field default value: true if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any inconsistencies that may result from changes to our database we recommend always setting correlate to true", + "type": "boolean" + }, + "date_from": { + "description": "starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 6 months minimal possible value: 2020-10-01 date format: \"yyyy-mm-dd\"", + "type": "string" + }, + "date_to": { + "description": "ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: \"yyyy-mm-dd\" example: \"2021-04-01\"", + "type": "string" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; default value: false", + "type": "boolean" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response; default value: false; Note: historical clickstream data is available from 2024/05 (May, 2024); with this parameter enabled, you will be charged double the price for the request; learn more about how clickstream-based metrics are calculated in this help center article", + "type": "boolean" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "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" + }, + "target": { + "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "target" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_keyword_ideas_live6 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "include_serp_info": true, - "keywords": [ - "phone", - "watch" - ], - "language_code": "en", - "limit": 3, - "location_code": 2840 - } -] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "example": [ - { - "include_serp_info": true, - "keywords": [ - "phone", - "watch" - ], - "language_code": "en", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "closely_variants": { - "description": "<em>search mode</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> the results will be based on the phrase-match search algorithm<br>if set to <code class=\"prettyprint\">false</code> the results will be based on the broad-match search algorithm<br>default value: <code>false</code>n", - "type": [ - "boolean", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keywords": { - "description": "<em>keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>The maximum number of keywords you can specify: 200.<br>The keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>700</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<p><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>[\"relevance,desc\",\"keyword_info.search_volume,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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "allOf": [ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + } + ], + "required": [ + "keywords" + ] + }, + { + "required": [ + "offset_token" + ] + } +] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "closely_variants": { + "description": "search mode optional field if set to_true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: falsen", + "type": "boolean" + }, + "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", + "items": {}, + "type": "array" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen", + "type": "boolean" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", + "type": "boolean" + }, + "include_serp_info": { + "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", + "type": "boolean" + }, + "keywords": { + "description": "keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. The keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", + "type": "string" + }, + "language_name": { + "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", + "type": "string" + }, + "limit": { + "description": "the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", + "type": "integer" + }, + "offset_token": { + "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", + "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 default rule: [\"relevance,desc\"] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint. note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"relevance,desc\",\"keyword_info.search_volume,desc\"]", + "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" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_keyword_overview_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "include_clickstream_data": true, - "include_serp_info": true, - "keywords": [ - "iphone" - ], - "language_code": "en", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "include_clickstream_data": true, - "include_serp_info": true, - "keywords": [ - "iphone" - ], - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keywords": { - "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", + "type": "boolean" + }, + "include_serp_info": { + "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", + "type": "boolean" + }, + "keywords": { + "description": "keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keywords" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_keyword_suggestions_live6 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "include_seed_keyword": true, - "include_serp_info": true, - "keyword": "phone", - "language_code": "en", - "limit": 1, - "location_code": 2840 - } -] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "example": [ - { - "include_seed_keyword": true, - "include_serp_info": true, - "keyword": "phone", - "language_code": "en", - "limit": 1, - "location_code": 2840 - } - ], - "properties": { - "exact_match": { - "description": "<em>search for the exact phrase</em><br>optional field<br>if set to <code>true</code>, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase<br>default value: <code>false</code>", - "type": [ - "boolean", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_seed_keyword": { - "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format;<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>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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>a comma is used as a separator<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "required": [ + "keyword" + ] + }, + { + "required": [ + "offset_token" + ] + } +] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "exact_match": { + "description": "search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: false", + "type": "boolean" + }, + "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", + "items": {}, + "type": "array" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", + "type": "boolean" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", + "type": "boolean" + }, + "include_seed_keyword": { + "description": "include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false", + "type": "boolean" + }, + "include_serp_info": { + "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", + "type": "boolean" + }, + "keyword": { + "description": "keyword required field UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "type": "string" + }, + "language_code": { + "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", + "type": "string" + }, + "language_name": { + "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", + "type": "integer" + }, + "offset_token": { + "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", + "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 a comma is used as a separator example: [\"keyword_info.competition,desc\"] default rule: [\"keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]", + "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" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_keywords_for_app_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_id": "org.telegram.messenger", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "language_name": "English", - "limit": 10, - "location_code": 2840 - } - ], - "properties": { - "app_id": { - "description": "<em>id of the apps</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", - "type": "string" - }, - "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "app_id": { + "description": "id of the apps required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger", + "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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 specify a sorting type; example: [\"ranked_serp_element.serp_item.rank_group,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_id" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_keywords_for_categories_live6 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "category_codes": [ - "12191", - "12193" - ], - "include_serp_info": true, - "language_name": "English", - "limit": 3, - "location_code": 2840 - } -] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "example": [ - { - "category_codes": [ - "12191", - "12193" - ], - "include_serp_info": true, - "language_name": "English", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "category_codes": { - "description": "<em>product and service categories</em><br><strong>required field</strong><br>The maximum number of categories you can specify: 20<br>you can download <a href=\"https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv\">the full list of possible categories</a>", - "items": { - "type": "string" - }, - "type": "array" - }, - "category_intersection": { - "description": "<em>category intersections</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, you will get keywords featured in all specified categories;<br>if set to <code class=\"prettyprint\">false</code>, you will keywords that are specified in any of the specified categories;<br>default value: <code>true</code>", - "type": [ - "boolean", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]</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: +[ + { + "allOf": [ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } + ], + "required": [ + "category_codes" + ] + }, + { + "required": [ + "offset_token" + ] + } +] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "category_codes": { + "description": "product and service categories required field The maximum number of categories you can specify: 20 you can download the full list of possible categories", + "items": { + "type": "integer" + }, + "type": "array" + }, + "category_intersection": { + "description": "category intersections optional field if set to true, you will get keywords featured in all specified categories; if set to false, you will keywords that are specified in any of the specified categories; default value: true", + "type": "boolean" + }, + "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", + "items": {}, + "type": "array" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", + "type": "boolean" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", + "type": "boolean" + }, + "include_serp_info": { + "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", + "type": "boolean" + }, + "language_code": { + "description": "unique language identifier required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", + "type": "integer" + }, + "offset_token": { + "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", + "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 type example: [\"keyword_info.competition,desc\"] default rule: [\"keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]", + "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" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_kw_for_site_live6 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "filters": [ - "serp_info.se_results_count", - ">", - 0 - ], - "include_serp_info": true, - "include_subdomains": true, - "language_code": "en", - "limit": 3, - "location_code": 2840, - "target": "apple.com" - } -] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "example": [ - { - "filters": [ - "serp_info.se_results_count", - ">", - 0 - ], - "include_serp_info": true, - "include_subdomains": true, - "language_code": "en", - "limit": 3, - "location_code": 2840, - "target": "apple.com" - } - ], - "properties": { - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_subdomains": { - "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<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>[\"relevance,desc\",\"keyword_info.search_volume,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" - ] - }, - "target": { - "description": "<em>domain name or page url</em><br><strong>required field</strong><br>the domain name of the target website, subdomain or URL of the target webpage;<br>the <strong>domain name</strong> must be specified <strong>without</strong> <code>https://</code> or <code>www.</code>;<br>the <strong>subdomain</strong> must be specified <strong>without</strong> <code>https://</code>;<br>the <strong>webpage URL</strong> must be specified <strong>with</strong> <code>https://</code> or <code>www.</code><br><strong>Note:</strong> if you specify the <strong>webpage URL</strong> without <code>https://</code> or <code>www.</code>, the result will be returned for the <strong>entire domain</strong> rather than the specific page", - "type": "string" - } - }, - "type": "object" - } -]New value: +[ + { + "allOf": [ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + } + ], + "required": [ + "target" + ] + }, + { + "required": [ + "offset_token" + ] + } +] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: [\"keyword_info.search_volume\",\">\",0] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to_true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article n\"", + "type": "boolean" + }, + "include_serp_info": { + "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", + "type": "boolean" + }, + "include_subdomains": { + "description": "indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true", + "type": "boolean" + }, + "language_code": { + "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", + "type": "string" + }, + "language_name": { + "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", + "type": "string" + }, + "limit": { + "description": "the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", + "type": "integer" + }, + "offset_token": { + "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", + "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 default rule: [\"relevance,desc\"] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"relevance,desc\",\"keyword_info.search_volume,desc\"]", + "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" + }, + "target": { + "description": "target domain required field the domain name of the target website the domain should be specified without https://", + "type": "string" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_related_keywords_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keyword": "phone", - "language_name": "English", - "limit": 3, - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keyword": "phone", - "language_name": "English", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code><p>number of the returned results depends on the value you set in this field<br>you can specify a level from 0 to 4<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 8 keywords<br>2 – 72 keywords<br>3 – 584 keywords<br>4 – 4680 keywords", - "type": [ - "integer", - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_data.keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "", - "type": [ - "boolean", - "null" - ] - }, - "include_seed_keyword": { - "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 type<br>example:<br><code>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "replace_with_core_keyword": { - "description": "<em>return data for core keyword</em><br>optional field<br>if <code>true</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the main keyword in the group that the specified <code>keyword</code> belongs to;<br>if <code>false</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the specified <code>keyword</code> (if available);<br>refer to <a href=\"https://dataforseo.com/help-center/replace_with_core_keyword\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a> for more details;<br>default value: <code>false</code>", - "type": [ - "boolean", - "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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "depth": { + "description": "keyword search depth optional field default value: 1 number of the returned results depends on the value you set in this field you can specify a level from 0 to 4 estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 8 keywords 2 – 72 keywords 3 – 584 keywords 4 – 4680 keywords", + "type": "integer" + }, + "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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_data.keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_data.keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_data.keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", + "items": {}, + "type": "array" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", + "type": "boolean" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", + "type": "boolean" + }, + "include_seed_keyword": { + "description": "include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false", + "type": "boolean" + }, + "include_serp_info": { + "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", + "type": "boolean" + }, + "keyword": { + "description": "keyword required field UTF-8 encoding the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "type": "string" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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 type example: [\"keyword_data.keyword_info.competition,desc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "replace_with_core_keyword": { + "description": "return data for core keyword optional field if true, serp_info and related_keywords will be returned for the main keyword in the group that the specified keyword belongs to; if false, serp_info and related_keywords will be returned for the specified keyword (if available); refer to this help center article for more details; default value: false", + "type": "boolean" + }, + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keyword" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_relevant_pages_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "filters": [ - [ - "metrics.organic.pos_1", - "<>", - 0 - ], - "or", - [ - "metrics.organic.pos_2_3", - "<>", - 0 - ] - ], - "language_name": "English", - "limit": 3, - "location_code": 2840, - "target": "amazon.com" - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "filters": [ - [ - "metrics.organic.pos_1", - "<>", - 0 - ], - "or", - [ - "metrics.organic.pos_2_3", - "<>", - 0 - ] - ], - "language_name": "English", - "limit": 3, - "location_code": 2840, - "target": "amazon.com" - } - ], - "properties": { - "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><p>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]]</code><p><code>[[\"\"metrics.organic.count\",\">\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "historical_serp_mode": { - "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", - "type": [ - "integer", - "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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 example: [\"metrics.paid.count\",\">\",0] [[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"\",0]] [[\"\"metrics.organic.count\",\">\",50\"], \"and\", [[\"metrics.organic.pos_1\",\"\",0],\"or\",[\"metrics.organic.pos_2_3\",\"\",0]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "historical_serp_mode": { + "description": "data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live", + "type": "string" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false", + "type": "boolean" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", + "type": "boolean" + }, + "item_types": { + "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned pages optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned pages optional field default value: 0 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", + "type": "integer" + }, + "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 specify a sorting type example: [\"metrics.paid.etv,asc\"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"] default rule: [\"metrics.organic.count,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", + "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" + }, + "target": { + "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "target" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_search_intent_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "keywords": [ - "login page", - "audi a7", - "elon musk", - "milk store new york" - ] - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "keywords": [ - "login page", - "audi a7", - "elon musk", - "milk store new york" - ] - } - ], - "properties": { - "keywords": { - "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "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" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "keywords": { + "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these languages only; example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports the following languages only: Arabic, ar, Chinese(Traditional), zh-TW, Czech, cs, Danish, da, Dutch, nl, English, en, Finnish, fi, French, fr, German, de, Hebrew, he, Hindi, hi, Italian, it, Japanese, ja, Korean, ko, Malay, ms, Norwegian(Bokmål), nb, Polish, pl, Portuguese, pt, Romanian, ro, Russian, ru, Spanish, es, Swedish, sv, Thai, th, Ukrainian, uk, Vietnamese, vi, Bulgarian, bg, Croatian, hr, Serbian, sr, Slovenian, sl, Bosnian, bs, Greek, el, Hungarian, hu, Slovak, sk, Turkish, tr example: English", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keywords" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_serp_competitors_live8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "item_types": [ - "organic" - ], - "keywords": [ - "phone" - ], - "language_name": "English", - "limit": 5, - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "item_types": [ - "organic" - ], - "keywords": [ - "phone" - ], - "language_name": "English", - "limit": 5, - "location_code": 2840 - } - ], - "properties": { - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"median_position\",\"in\",[1,10]]</code><p><code>[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]</code><p><code>[[\"domain\",\"not_like\",\"%wikipedia.org%\"],<br>\"and\",<br>[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "include_subdomains": { - "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>search results type</em><br>indicates type of search results included in the response<br>optional field<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "keywords": { - "description": "<em>keywords array</em><br><strong>required field</strong><br>the results will be based on the keywords you specify in this array<br>UTF-8 encoding;<br>the keywords will be converted to lowercase format;<br><strong>you can specify the maximum of 200 keywords</strong><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>", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with <code>location_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", - "type": [ - "integer", - "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>the comma is used as a separator<br>example:<br><code>[\"avg_position,asc\"]</code><br>default rule:<br><code>[\"rating,desc\"]</code><br><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>[\"avg_position,asc\",\"etv,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" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"median_position\",\"in\",[1,10]] [[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]] [[\"domain\",\"not_like\",\"%wikipedia.org%\"], \"and\", [[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "include_subdomains": { + "description": "indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true", + "type": "boolean" + }, + "item_types": { + "description": "search results type indicates type of search results included in the response optional field possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "keywords": { + "description": "keywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; you can specify the maximum of 200 keywords learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "unique language identifier required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned domains optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with location_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", + "type": "integer" + }, + "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 the comma is used as a separator example: [\"avg_position,asc\"] default rule: [\"rating,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"avg_position,asc\",\"etv,desc\"]", + "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" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "keywords" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_subdomains_live7 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "filters": [ - [ - "metrics.organic.pos_1", - "<>", - 0 - ], - "or", - [ - "metrics.organic.pos_2_3", - "<>", - 0 - ] - ], - "language_name": "English", - "location_code": 2840, - "target": "dataforseo.com" - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "filters": [ - [ - "metrics.organic.pos_1", - "<>", - 0 - ], - "or", - [ - "metrics.organic.pos_2_3", - "<>", - 0 - ] - ], - "language_name": "English", - "location_code": 2840, - "target": "dataforseo.com" - } - ], - "properties": { - "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><br>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]]</code><p><code>[[\"metrics.organic.count\",\">\",\"10\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "historical_serp_mode": { - "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", - "type": [ - "string", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "item_types": { - "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": [ - "string", - "null" - ] - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": [ - "integer", - "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", - "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" - ] - }, - "target": { - "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", - "type": "string" - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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 example: [\"metrics.paid.count\",\">\",0] [[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]] [[\"metrics.organic.count\",\">\",\"10\"], \"and\", [[\"metrics.organic.pos_1\",\"\",0],\"or\",[\"metrics.organic.pos_2_3\",\"\",0]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", + "items": {}, + "type": "array" + }, + "historical_serp_mode": { + "description": "data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live", + "type": "string" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false", + "type": "boolean" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", + "type": "boolean" + }, + "item_types": { + "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": "integer" + }, + "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 specify a sorting type example: [\"metrics.paid.etv,asc\"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"] default rule: [\"metrics.organic.count,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", + "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" + }, + "target": { + "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "target" +] - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_labs_google_top_searches_live6 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "language_name": "English", - "limit": 3, - "location_code": 2840 - } -] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "example": [ - { - "language_name": "English", - "limit": 3, - "location_code": 2840 - } - ], - "properties": { - "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "ignore_synonyms": { - "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "include_clickstream_data": { - "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", - "type": [ - "boolean", - "null" - ] - }, - "include_serp_info": { - "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", - "type": [ - "boolean", - "null" - ] - }, - "language_code": { - "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "limit": { - "description": "<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>", - "type": [ - "integer", - "null" - ] - }, - "location_code": { - "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", - "type": "string" - }, - "offset": { - "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "allOf": [ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "required": [ + "language_name" + ] + }, + { + "required": [ + "language_code" + ] + } + ] + } + ] + }, + { + "required": [ + "offset_token" + ] + } +] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like,as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", + "items": {}, + "type": "array" + }, + "ignore_synonyms": { + "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", + "type": "boolean" + }, + "include_clickstream_data": { + "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", + "type": "boolean" + }, + "include_serp_info": { + "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", + "type": "boolean" + }, + "language_code": { + "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", + "type": "string" + }, + "limit": { + "description": "the maximum number of returned keywords optional field note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request default value: 1000 maximum value: 1000", + "type": "integer" + }, + "location_code": { + "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", + "type": "integer" + }, + "location_name": { + "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", + "type": "string" + }, + "offset": { + "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", + "type": "integer" + }, + "offset_token": { + "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", + "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 type example: [\"keyword_info.competition,desc\"] default rule: [\"keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]", + "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" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - changed
Input schema / requiredPrevious value: -[]New value: +[ + "body" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
search17 fields changed- removed
Input schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema" - added
Input schema / properties / category / anyOfAdded value: +[ + { + "enum": [ + "seo", + "finance", + "social", + "search", + "sales", + "mail" + ], + "type": "string" + }, + { + "type": "null" + } +] - added
Input schema / properties / category / defaultAdded value: +null - changed
Input 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." - removed
Input schema / properties / category / enumRemoved value: -[ - "seo", - "finance", - "social", - "search", - "sales", - "mail" -] - removed
Input schema / properties / category / typeRemoved value: -"string" - removed
Input schema / properties / known_fieldsRemoved value: -{ - "additionalProperties": true, - "default": {}, - "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.", - "type": "object" -} - changed
Input schema / properties / limit / descriptionPrevious value: -"Maximum number of additional direct tool candidates."New value: +"Maximum candidates, 1-10" - removed
Input schema / properties / limit / maximumRemoved value: -20 - removed
Input schema / properties / limit / minimumRemoved value: -1 - removed
Input 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 -} - changed
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." - removed
Input schema / properties / query / maxLengthRemoved value: -2000 - removed
Input schema / properties / query / minLengthRemoved value: -1 - removed
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" -} - removed
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" - } - } -} - removed
Output schema / requiredRemoved value: -[ - "next_steps_guidance", - "search_id", - "session_id", - "tools" -]
- Changed
use1 field changed- changed
Input 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"
52 tool updates
- Added
batch_get_schema - Added
batch_quote - Changed
batch_use18 fields changed- added
Input schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - removed
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" - added
Input schema / properties / calls / items / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - changed
Input schema / properties / calls / items / additionalPropertiesPrevious value: -trueNew value: +false - added
Input 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" + } +} - added
Input schema / properties / calls / items / requiredAdded value: +[ + "call_id", + "tool", + "arguments" +] - added
Input schema / properties / calls / maxItemsAdded value: +20 - added
Input schema / properties / calls / minItemsAdded value: +1 - removed
Input schema / properties / max_price_usdRemoved value: -{ - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "default": null, - "description": "Per-call price cap applied to every item" -} - removed
Input schema / properties / search_id / anyOfRemoved value: -[ - { - "type": "string" - }, - { - "type": "null" - } -] - removed
Input schema / properties / search_id / defaultRemoved value: -null - changed
Input schema / properties / search_id / descriptionPrevious value: -"search_id from the search that found these operations"New value: +"Optional search correlation identifier returned by search." - added
Input schema / properties / search_id / typeAdded value: +"string" - added
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" +} - added
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." + } +} - added
Output schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - added
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" + } +} - added
Output schema / requiredAdded value: +[ + "session_id", + "batch_id", + "total_count", + "success_count", + "error_count", + "results", + "next_steps_guidance" +]
- Changed
get_ahrefs_domain_rating2 fields changed- added
Input schema / properties / target / exampleAdded value: +"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "target", - "date" -]New value: +[ + "date", + "target" +]
- Changed
get_ahrefs_site_metrics2 fields changed- added
Input schema / properties / target / exampleAdded value: +"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "target", - "date" -]New value: +[ + "date", + "target" +]
- Changed
get_dataforseo_labs_available_filters1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_labs_google_available_history1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_labs_google_categories_for_kw_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_labs_status1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_details13 fields changed- added
Input schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - removed
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." -} - added
Input schema / properties / include_arguments_schemaAdded value: +{ + "default": true, + "description": "Return the complete arguments_schema. Defaults to true.", + "type": "boolean" +} - changed
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." - added
Input schema / properties / include_response_schemaAdded value: +{ + "default": false, + "description": "Return the complete response_schema. Defaults to false.", + "type": "boolean" +} - removed
Input schema / properties / operation_idRemoved value: -{ - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "description": "One operation_id from search" -} - removed
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" -} - added
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" +} - added
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 +} - removed
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" -} - added
Input schema / requiredAdded value: +[ + "tools" +] - added
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" + } +} - added
Output schema / requiredAdded value: +[ + "error_count", + "next_steps_guidance", + "session_id", + "success_count", + "tools", + "total_count" +]
- Changed
get_semrush_domain_organic_keywords5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`." - removed
Input schema / properties / domain / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "domain", - "database" -]New value: +[ + "database", + "domain" +]
- Changed
get_semrush_domain_overview2 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code. Defaults to `us`. Examples: `us`, `uk`, `cn`." - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`."
- Changed
get_semrush_domain_paid_keywords5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`." - removed
Input schema / properties / domain / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "domain", - "database" -]New value: +[ + "database", + "domain" +]
- Changed
get_semrush_domain_rank_history5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`." - removed
Input schema / properties / domain / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "domain", - "database" -]New value: +[ + "database", + "domain" +]
- Changed
get_semrush_domain_vs_domain5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domains / descriptionRemoved value: -"Comparison spec: `sign|type|domain` groups joined by `|` (sign in + - * /, type in `or`/`ad`). Example: `+|or|ahrefs.com|+|or|semrush.com`." - removed
Input schema / properties / domains / exampleRemoved value: -"+|or|ahrefs.com|+|or|semrush.com" - changed
Input schema / requiredPrevious value: -[ - "domains", - "database" -]New value: +[ + "database", + "domains" +]
- Changed
get_semrush_organic_competitors5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / domain / descriptionRemoved value: -"Target domain, e.g. `ahrefs.com`." - removed
Input schema / properties / domain / exampleRemoved value: -"ahrefs.com" - changed
Input schema / requiredPrevious value: -[ - "domain", - "database" -]New value: +[ + "database", + "domain" +]
- Changed
get_semrush_url_organic_keywords5 fields changed- removed
Input schema / properties / database / descriptionRemoved value: -"Regional database / country code, e.g. `us`." - removed
Input schema / properties / database / exampleRemoved value: -"us" - removed
Input schema / properties / url / descriptionRemoved value: -"Target URL (landing page)." - removed
Input schema / properties / url / exampleRemoved value: -"https://ahrefs.com/blog/" - changed
Input schema / requiredPrevious value: -[ - "url", - "database" -]New value: +[ + "database", + "url" +]
- Changed
post_dataforseo_labs_amazon_bulk_volume_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "buy laptop", + "cheap laptops for sale", + "purchase laptop" + ], + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "buy laptop", + "cheap laptops for sale", + "purchase laptop" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports <a href=\"#loc\">these locations and languages only;</a><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><a name=\"loc\"></a><br><strong>Note:</strong> this endpoint currently supports the following locations and languages only:<p><code>Australia</code> - <code>2036</code>, <code>en</code><br><code>Austria</code> - <code>2040</code>, <code>de</code><br><code>Canada</code> - <code>2124</code>, <code>en</code><br><code>Egypt</code> - <code>2818</code>, <code>ar</code><br><code>France</code> - <code>2250</code>, <code>fr</code><br><code>Germany</code> - <code>2276</code>, <code>de</code><br><code>India</code> - <code>2356</code>, <code>en</code><br><code>Italy</code> - <code>2380</code>, <code>it</code><br><code>Mexico</code> - <code>2484</code>, <code>es</code><br><code>Netherlands</code> - <code>2528</code>, <code>nl</code><br><code>Saudi Arabia</code> - <code>2682</code>, <code>ar</code><br><code>Singapore</code> - <code>2702</code>, <code>en</code><br><code>Spain</code> - <code>2724</code>, <code>es</code><br><code>United Arab Emirates</code> - <code>2784</code>, <code>ar</code><br><code>United Kingdom</code> - <code>2826</code>, <code>en</code><br><code>United States</code> - <code>2840</code>, <code>en</code><br>example:<br><code class=\"long-string\">United States</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these locations and languages only; example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these locations and languages only; example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports these locations and languages only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the following locations and languages only: Australia – 2036, en Austria – 2040, de Canada – 2124, en Egypt – 2818, ar France – 2250, fr Germany – 2276, de India – 2356, en Italy – 2380, it Mexico – 2484, es Netherlands – 2528, nl Saudi Arabia – 2682, ar Singapore – 2702, en Spain – 2724, es United Arab Emirates – 2784, ar United Kingdom – 2826, en United States – 2840, en example: United States", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_product_competitors_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "asin": "019005476X", + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "asin": "019005476X", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "asin": { + "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", + "type": "string" + }, + "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"full_metrics.amazon_serp.pos_1\",\">\", 20]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned product competitors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", + "type": [ + "integer", + "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>[\"full_metrics.amazon_serp.pos_1,desc\"]</code><br><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>[\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "asin": { - "description": "product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint", - "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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"full_metrics.amazon_serp.pos_1\",\">\", 20] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of products in the results array optional field default value: 100; maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned product competitors optional field default value: 0 if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors", - "type": "integer" - }, - "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: [\"full_metrics.amazon_serp.pos_1,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"full_metrics.amazon_serp.pos_1,desc\",\"avg_position,desc\"] default rule: [\"ranked_serp_element.serp_item.rank_group,asc\"]", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "asin" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_product_kw_overlap_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "asins": { + "1": "B09172433Z", + "2": "B07GBZ4Q68", + "3": "B07GCKQD77" + }, + "language_name": "English", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "asins": { + "1": "B09172433Z", + "2": "B07GBZ4Q68", + "3": "B07GCKQD77" + }, + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "asins": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>asins of target products</em><br><strong>required field</strong><br>product IDs of the products for which you need to find keyword intersections;<br>specify the ASINs as in the following example:<br><code>\"asins\": {<br>\"1\": \"019005476X\",<br>\"2\": \"0190074442\"<br>}</code><br><strong>the maximum number of ASINs you can specify in this object is 20;</strong><br>learn more about the parameter on <a href=\"https://dataforseo.com/help-center/how-to-get-amazon-product-data-using-asin\" rel=\"noopener noreferrer\" target=\"_blank\">this help center page</a>", + "type": [ + "object", + "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>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</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>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"avg_position\",\"<\", 10]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "intersection_mode": { + "description": "<em>mode for finding asin intersections</em><br>optional field<br>possible values: <code>union</code>, <code>intersect</code>;<br>default value: <code>intersect</code>;<br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/what-is-intersection-mode-in-amazon-keyword-intersections-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>", + "type": [ + "string", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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>[\"sum_position,desc\"]</code><br><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>[\"intersections,desc\",\"avg_position,asc\"]</code><br>default rule:<br><code>[\"intersections,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "asins": { - "additionalProperties": { - "type": "string" - }, - "description": "asins of target products required field product IDs of the products for which you need to find keyword intersections; specify the ASINs as in the following example: \"asins\": { \"1\": \"019005476X\", \"2\": \"0190074442\" } the maximum number of ASINs you can specify in this object is 20; learn more about the parameter on this help center page", - "type": "object" - }, - "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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"avg_position\",\"<\", 10] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "intersection_mode": { - "description": "mode for finding asin intersections optional field possible values: union, intersect; default value: intersect; learn more about the parameter in this help center guide", - "type": "string" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of products in the results array optional field default value: 100; maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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: [\"sum_position,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"intersections,desc\",\"avg_position,asc\"] default rule: [\"intersections,desc\"]", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "asins" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_product_rank_overview_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "asins": [ + "B001TJ3HUG", + "B01LW2SL7R" + ], + "language_name": "English", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "asins": [ + "B001TJ3HUG", + "B01LW2SL7R" + ], + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "asins": { + "description": "<em>product IDs to compare</em><br><strong>required field</strong><br>product IDs to receive ranking data for;<br><strong>the maximum number of ASINs you can specify in this array is 1000;</strong><br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a><p><strong>Note:</strong> all letters in ASIN code must be specified in uppercase format;<br>example:<br><code>B01LW2SL7R</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "asins": { - "description": "product IDs to compare required field product IDs to receive ranking data for; the maximum number of ASINs you can specify in this array is 1000; you can receive the asin parameter by making a separate request to the Amazon Products endpoint Note: all letters in ASIN code must be specified in uppercase format; example: B01LW2SL7R", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "asins" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_ranked_keywords_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "asin": "B00R92CL5E", + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "asin": "B00R92CL5E", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "asin": { + "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>", + "type": "string" + }, + "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>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>[\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]</code>;<p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "asin": { - "description": "product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint", - "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, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: [\"keyword_data.keyword_info.search_volume\",\"in\",[100,1000]]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of products in the results array optional field default value: 100; maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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: [\"keyword_data.keyword_info.competition,desc\"] default rule: [\"ranked_serp_element.serp_item.rank_group,asc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "asin" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_amazon_related_keywords_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "include_seed_keyword": true, + "keyword": "computer mouse", + "language_name": "English", + "limit": 5, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "include_seed_keyword": true, + "keyword": "computer mouse", + "language_name": "English", + "limit": 5, + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code>;<br>number of the returned results depends on the value you set in this field;<br>you can specify a level from 0 to 4;<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 6 keywords<br>2 – 42 keywords<br>3 – 258 keywords<br>4 – 1554 keywords", + "type": [ + "integer", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords should be specified in the lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "keyword search depth optional field default value: 1; number of the returned results depends on the value you set in this field; you can specify a level from 0 to 4; estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 6 keywords 2 – 42 keywords 3 – 258 keywords 4 – 1554 keywords", - "type": "integer" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen", - "type": "boolean" - }, - "include_seed_keyword": { - "description": "include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false", - "type": "boolean" - }, - "keyword": { - "description": "keyword required field UTF-8 encoding the keywords should be specified in the lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_apple_app_competitors_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.app_store_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_id": { - "description": "id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320", - "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: , , >, >=, =, , in, not_in example: [\"intersections\",\">\",500] [[\"competitor_metrics.app_store_search_organic.pos_1\",\"\",10],\"and\",[\"avg_position\",\">=\",\"10\"]] [[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]], \"or\", [\"sum_position\",\">=\",\"10000\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"intersections,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersections,desc\",\"sum_position,asc\"] default rule: [\"intersections,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_apple_app_intersection_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the ids should be specified the following way:<br>`\"app_ids\": {<br>\"1\": \"686449807\",<br>\"2\": \"382617920\"<br>}`<br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", + "type": [ + "object", + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_ids": { - "additionalProperties": { - "type": "string" - }, - "description": "ids of the target apps required field IDs of the target mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; the ids should be specified the following way: \"app_ids\": { \"1\": \"686449807\", \"2\": \"382617920\" } if you specify a single ID here, the API will return results only for one application; the maximum number of app IDs you can specify in this object is 20", - "type": "object" - }, - "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"intersection_result.382617920.rank_absolute,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_ids" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_apple_bulk_app_metrics_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_ids": [ + "686449807", + "382617920" + ], + "language_name": "English", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_ids": [ + "686449807", + "382617920" + ], + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "description": "<em>ids of the apps</em><br><strong>required field</strong><br>IDs of mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_ids": { - "description": "ids of the apps required field IDs of mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320; the maximum number of IDs you can specify in this field is 1000", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_ids" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_apple_keywords_for_app_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "686449807", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_id": { - "description": "id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320", - "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"ranked_serp_element.serp_item.rank_group,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_app_competitors_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"intersections\",\">\",500]</code><p><code>[[\"competitor_metrics.google_play_search_organic.pos_1\",\"<>\",10],\"and\",[\"avg_position\",\">=\",\"10\"]]</code><p><code>[[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\">=\",\"10000\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersections,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>default rule:<br><code>[\"intersections,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_id": { - "description": "id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger", - "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: , , >, >=, =, , in, not_in example: [\"intersections\",\">\",500] [[\"competitor_metrics.google_play_search_organic.pos_1\",\"\",10],\"and\",[\"avg_position\",\">=\",\"10\"]] [[[\"intersections\",\">=\",50],\"and\",[\"competitor_metrics.google_play_search_organic.pos_1\",\"in\",[1,5]]], \"or\", [\"sum_position\",\">=\",\"10000\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"intersections,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersections,desc\",\"sum_position,asc\"] default rule: [\"intersections,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_app_intersection_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_ids": { + "1": "686449807", + "2": "382617920" + }, + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "additionalProperties": { + "type": [ + "string", + "null" + ] + }, + "description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;;<br>the ids should be specified the following way:<br><code>\"app_ids\": {<br>\"1\": \"org.telegram.messenger\",<br>\"2\": \"com.zhiliaoapp.musically\"<br>}</code><br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>", + "type": [ + "object", + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_ids": { - "additionalProperties": { - "type": "string" - }, - "description": "ids of the target apps required field IDs of the target mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger;; the ids should be specified the following way: \"app_ids\": { \"1\": \"org.telegram.messenger\", \"2\": \"com.zhiliaoapp.musically\" } if you specify a single ID here, the API will return results only for one application; the maximum number of app IDs you can specify in this object is 20", - "type": "object" - }, - "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"intersection_result.382617920.rank_absolute,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_ids" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_bulk_app_metrics_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_ids": [ + "org.telegram.messenger", + "com.zhiliaoapp.musically" + ], + "language_name": "English", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_ids": [ + "org.telegram.messenger", + "com.zhiliaoapp.musically" + ], + "language_name": "English", + "location_code": 2840 + } + ], + "properties": { + "app_ids": { + "description": "<em>ids of the app</em><br><strong>required field</strong><br>IDs of the mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_ids": { - "description": "ids of the app required field IDs of the mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger; the maximum number of IDs you can specify in this field is 1000", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_ids" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_bulk_keyword_difficulty_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_bulk_traffic_estimation_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } + ], + "properties": { + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" + ] + }, + "targets": { + "description": "<em>target domains, subdomains, and webpages</em><br><strong>required field</strong><br>you can specify domains, subdomains, and webpages in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>pages should be specified with absolute URL, including <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains, subdomains or webpages", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code if you use this field, you don’t have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location if you use this field, you don’t have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "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" - }, - "targets": { - "description": "target domains, subdomains, and webpages required field you can specify domains, subdomains, and webpages in this field; domains and subdomains should be specified without https:// and www.; pages should be specified with absolute URL, including https:// and www.; you can set up to 1000 domains, subdomains or webpages", - "items": { - "type": "string" - }, - "type": "array" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "targets" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_categories_for_domain_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "item_types": [ + "paid", + "organic", + "featured_snippet", + "local_pack" + ], + "language_code": "en", + "limit": 3, + "location_name": "United States", + "target": "dataforseo.com" + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "item_types": [ + "paid", + "organic", + "featured_snippet", + "local_pack" + ], + "language_code": "en", + "limit": 3, + "location_name": "United States", + "target": "dataforseo.com" + } + ], + "properties": { + "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><br>example:<br><code>[\"metrics.organic.pos_1,\">\",0]</code><p><code>[[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]],<br>\"or\",<br>[\"metrics.organic.etv\",\"in\",[10,100]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and_<code>clickstream_age_distribution</code>_fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>n", + "type": [ + "boolean", + "null" + ] + }, + "include_subcategories": { + "description": "<em>indicates if the subcategories will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subcategories will be ignored<br>default value: <code>false</code><br>learn more about the parameter in this <a href=\"https://dataforseo.com/help-center/include_subcategories-in-categories-for-domain-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned categories</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned categories </em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain or subdomain</em><br><strong>required field</strong><br>the domain or subdomain name of the target website<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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 example: [\"metrics.organic.pos_1,\">\",0] [[[\"metrics.organic.count\",\">=\",100],\"and\",[\"metrics.organic.pos_1\",\">\",0]], \"or\", [\"metrics.organic.etv\",\"in\",[10,100]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "historical_serp_mode": { - "description": "data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live", - "type": "string" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to_true, you will receive clickstream_etv, clickstream_gender_distribution, and_clickstream_age_distribution_fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article n", - "type": "boolean" - }, - "include_subcategories": { - "description": "indicates if the subcategories will be included in the search optional field if set to false, the subcategories will be ignored default value: false learn more about the parameter in this help center article", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned categories optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned categories optional field default value: 0 if you specify the 10 value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories", - "type": "integer" - }, - "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 specify a sorting type example: [\"metrics.paid.etv,asc\"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"] default rule: [\"metrics.organic.count,desc\"] Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array", - "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" - }, - "target": { - "description": "domain or subdomain required field the domain or subdomain name of the target website the domain or subdomain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_categories_for_kw_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en" + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "dentist new york", + "pizza brooklyn", + "car dealer los angeles" + ], + "language_code": "en" + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if don't 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 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class=\"long-string\">English</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages example: English", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_domain_rank_overview_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } + ], + "properties": { + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code>, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms<br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned results for domain</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned items</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten <code>items</code> in the results array will be omitted and the data will be provided for the successive items", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value: falsen", - "type": "boolean" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned results for domain optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items", - "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" - }, - "target": { - "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_historical_bulk_traffic_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "item_types": [ + "organic", + "paid" + ], + "language_code": "en", + "location_code": 2840, + "targets": [ + "dataforseo.com", + "cnn.com", + "forbes.com" + ] + } + ], + "properties": { + "date_from": { + "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 12 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", + "type": [ + "string", + "null" + ] + }, + "date_to": { + "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default;<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response;<br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array;<br>possible values:<br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value:<br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>if you use this field, you don't have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>if you use this field, you don't have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</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" + ] + }, + "targets": { + "description": "<em>target domains and subdomains</em><br><strong>required field</strong><br>you can specify domains and subdomains in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains or subdomains", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "date_from": { - "description": "starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 12 months minimal possible value: 2020-10-01 date format: \"yyyy-mm-dd\"", - "type": "string" - }, - "date_to": { - "description": "ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default; date format: \"yyyy-mm-dd\" example: \"2021-04-01\"", - "type": "string" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response; Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code if you use this field, you don’t have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location if you use this field, you don’t have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "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" - }, - "targets": { - "description": "target domains and subdomains required field you can specify domains and subdomains in this field; domains and subdomains should be specified without https:// and www.; you can set up to 1000 domains or subdomains", - "items": { - "type": "string" - }, - "type": "array" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "targets" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_historical_keyword_data_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_historical_rank_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "language_code": "en", + "location_code": 2840, + "target": "dataforseo.com" + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "date_from": "2021-01-01", + "date_to": "2021-03-29", + "language_code": "en", + "location_code": 2840, + "target": "dataforseo.com" + } + ], + "properties": { + "correlate": { + "description": "<em>correlate data with previously obtained datasets</em><br>optional field<br>default value: <code>true</code><br>if you use this parameter, our system will correlate data you obtain now with previously obtained datasets<br>this parameter is intended to mitigate any inconsistencies that may result from changes to our database<br>we recommend always setting <code>correlate</code> to <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "date_from": { + "description": "<em>starting date of the time range</em><br>optional field<br>if you don't specify this field, the data will be provided for the previous 6 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>\"yyyy-mm-dd\"</code>", + "type": [ + "string", + "null" + ] + }, + "date_to": { + "description": "<em>ending date of the time range</em><br>optional field<br>if you don't specify this field, the today's date will be used by default<br>date format: <code>\"yyyy-mm-dd\"</code><br>example:<br><code>\"2021-04-01\"</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response;<br>default value: <code>false</code>;<p><strong>Note:</strong> historical clickstream data is available from 2024/05 (May, 2024);<br><strong>with this parameter enabled, you will be charged double the price for the request;</strong><br>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "correlate": { - "description": "correlate data with previously obtained datasets optional field default value: true if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any inconsistencies that may result from changes to our database we recommend always setting correlate to true", - "type": "boolean" - }, - "date_from": { - "description": "starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 6 months minimal possible value: 2020-10-01 date format: \"yyyy-mm-dd\"", - "type": "string" - }, - "date_to": { - "description": "ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: \"yyyy-mm-dd\" example: \"2021-04-01\"", - "type": "string" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response; default value: false; Note: historical clickstream data is available from 2024/05 (May, 2024); with this parameter enabled, you will be charged double the price for the request; learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "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" - }, - "target": { - "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keyword_ideas_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "include_serp_info": true, + "keywords": [ + "phone", + "watch" + ], + "language_code": "en", + "limit": 3, + "location_code": 2840 + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "allOf": [ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - } - ], - "required": [ - "keywords" - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "include_serp_info": true, + "keywords": [ + "phone", + "watch" + ], + "language_code": "en", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "closely_variants": { + "description": "<em>search mode</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> the results will be based on the phrase-match search algorithm<br>if set to <code class=\"prettyprint\">false</code> the results will be based on the broad-match search algorithm<br>default value: <code>false</code>n", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>n", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>The maximum number of keywords you can specify: 200.<br>The keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>700</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<p><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>[\"relevance,desc\",\"keyword_info.search_volume,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "closely_variants": { - "description": "search mode optional field if set to_true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: falsen", - "type": "boolean" - }, - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "keywords": { - "description": "keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. The keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "limit": { - "description": "the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 default rule: [\"relevance,desc\"] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint. note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"relevance,desc\",\"keyword_info.search_volume,desc\"]", - "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" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keyword_overview_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "include_clickstream_data": true, + "include_serp_info": true, + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "include_clickstream_data": true, + "include_serp_info": true, + "keywords": [ + "iphone" + ], + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keywords": { + "description": "<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "keywords": { - "description": "keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keyword_suggestions_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "include_seed_keyword": true, + "include_serp_info": true, + "keyword": "phone", + "language_code": "en", + "limit": 1, + "location_code": 2840 + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "required": [ - "keyword" - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "include_seed_keyword": true, + "include_serp_info": true, + "keyword": "phone", + "language_code": "en", + "limit": 1, + "location_code": 2840 + } + ], + "properties": { + "exact_match": { + "description": "<em>search for the exact phrase</em><br>optional field<br>if set to <code>true</code>, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase<br>default value: <code>false</code>", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format;<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>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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>a comma is used as a separator<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "exact_match": { - "description": "search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: false", - "type": "boolean" - }, - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_seed_keyword": { - "description": "include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "keyword": { - "description": "keyword required field UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 a comma is used as a separator example: [\"keyword_info.competition,desc\"] default rule: [\"keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]", - "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" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keywords_for_app_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "language_name": "English", + "limit": 10, + "location_code": 2840 + } + ], + "properties": { + "app_id": { + "description": "<em>id of the apps</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "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><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_id": { - "description": "id of the apps required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger", - "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: , , >, >=, =, , in, not_in example: [\"keyword_data.keyword_info.search_volume\",\">\",500] [[\"keyword_data.keyword_info.search_volume\",\"\",500],\"and\",[\"ranked_serp_element.serp_item.rank_group\",\">=\",\"10\"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type; example: [\"ranked_serp_element.serp_item.rank_group,asc\"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: [\"ranked_serp_element.serp_item.rank_group,desc\",\"keyword_data.keyword_info.search_volume,asc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_id" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_keywords_for_categories_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "category_codes": [ + "12191", + "12193" + ], + "include_serp_info": true, + "language_name": "English", + "limit": 3, + "location_code": 2840 + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "allOf": [ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } - ], - "required": [ - "category_codes" - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "category_codes": [ + "12191", + "12193" + ], + "include_serp_info": true, + "language_name": "English", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "category_codes": { + "description": "<em>product and service categories</em><br><strong>required field</strong><br>The maximum number of categories you can specify: 20<br>you can download <a href=\"https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv\">the full list of possible categories</a>", + "items": { + "type": "string" + }, + "type": "array" + }, + "category_intersection": { + "description": "<em>category intersections</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, you will get keywords featured in all specified categories;<br>if set to <code class=\"prettyprint\">false</code>, you will keywords that are specified in any of the specified categories;<br>default value: <code>true</code>", + "type": [ + "boolean", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<br>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]</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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "category_codes": { - "description": "product and service categories required field The maximum number of categories you can specify: 20 you can download the full list of possible categories", - "items": { - "type": "integer" - }, - "type": "array" - }, - "category_intersection": { - "description": "category intersections optional field if set to true, you will get keywords featured in all specified categories; if set to false, you will keywords that are specified in any of the specified categories; default value: true", - "type": "boolean" - }, - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "language_code": { - "description": "unique language identifier required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 type example: [\"keyword_info.competition,desc\"] default rule: [\"keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_info.search_volume,desc\",\"keyword_info.competition,asc\"]", - "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" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_kw_for_site_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "filters": [ + "serp_info.se_results_count", + ">", + 0 + ], + "include_serp_info": true, + "include_subdomains": true, + "language_code": "en", + "limit": 3, + "location_code": 2840, + "target": "apple.com" + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "allOf": [ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - } - ], - "required": [ - "target" - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "filters": [ + "serp_info.se_results_count", + ">", + 0 + ], + "include_serp_info": true, + "include_subdomains": true, + "language_code": "en", + "limit": 3, + "location_code": 2840, + "target": "apple.com" + } + ], + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" target=\"_blank\" rel=\"noopener noreferrer\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_subdomains": { + "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href=\"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages\" target=\"_blank\">Locations and Languages endpoint</a> to determine the default language", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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<p>default rule:<br><code>[\"relevance,desc\"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href=\"/v3/keywords_data/google/keywords_for_keywords/live/?php\">the Keywords For Keywords</a> endpoint.<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>[\"relevance,desc\",\"keyword_info.search_volume,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" + ] + }, + "target": { + "description": "<em>domain name or page url</em><br><strong>required field</strong><br>the domain name of the target website, subdomain or URL of the target webpage;<br>the <strong>domain name</strong> must be specified <strong>without</strong> <code>https://</code> or <code>www.</code>;<br>the <strong>subdomain</strong> must be specified <strong>without</strong> <code>https://</code>;<br>the <strong>webpage URL</strong> must be specified <strong>with</strong> <code>https://</code> or <code>www.</code><br><strong>Note:</strong> if you specify the <strong>webpage URL</strong> without <code>https://</code> or <code>www.</code>, the result will be returned for the <strong>entire domain</strong> rather than the specific page", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: [\"keyword_info.search_volume\",\">\",0] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to_true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article n\"", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "include_subdomains": { - "description": "indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true", - "type": "boolean" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language", - "type": "string" - }, - "limit": { - "description": "the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 default rule: [\"relevance,desc\"] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"relevance,desc\",\"keyword_info.search_volume,desc\"]", - "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" - }, - "target": { - "description": "target domain required field the domain name of the target website the domain should be specified without https://", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_related_keywords_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keyword": "phone", + "language_name": "English", + "limit": 3, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keyword": "phone", + "language_name": "English", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>keyword search depth</em><br>optional field<br>default value: <code>1</code><p>number of the returned results depends on the value you set in this field<br>you can specify a level from 0 to 4<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 8 keywords<br>2 – 72 keywords<br>3 – 584 keywords<br>4 – 4680 keywords", + "type": [ + "integer", + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_data.keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "", + "type": [ + "boolean", + "null" + ] + }, + "include_seed_keyword": { + "description": "<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format<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>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 type<br>example:<br><code>[\"keyword_data.keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "replace_with_core_keyword": { + "description": "<em>return data for core keyword</em><br>optional field<br>if <code>true</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the main keyword in the group that the specified <code>keyword</code> belongs to;<br>if <code>false</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the specified <code>keyword</code> (if available);<br>refer to <a href=\"https://dataforseo.com/help-center/replace_with_core_keyword\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a> for more details;<br>default value: <code>false</code>", + "type": [ + "boolean", + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "keyword search depth optional field default value: 1 number of the returned results depends on the value you set in this field you can specify a level from 0 to 4 estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 8 keywords 2 – 72 keywords 3 – 584 keywords 4 – 4680 keywords", - "type": "integer" - }, - "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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_data.keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_data.keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_data.keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_seed_keyword": { - "description": "include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "keyword": { - "description": "keyword required field UTF-8 encoding the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 type example: [\"keyword_data.keyword_info.competition,desc\"] default rule: [\"keyword_data.keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_data.keyword_info.search_volume,desc\",\"keyword_data.keyword_info.cpc,desc\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "replace_with_core_keyword": { - "description": "return data for core keyword optional field if true, serp_info and related_keywords will be returned for the main keyword in the group that the specified keyword belongs to; if false, serp_info and related_keywords will be returned for the specified keyword (if available); refer to this help center article for more details; default value: false", - "type": "boolean" - }, - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keyword" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_relevant_pages_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "limit": 3, + "location_code": 2840, + "target": "amazon.com" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "limit": 3, + "location_code": 2840, + "target": "amazon.com" + } + ], + "properties": { + "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><p>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"<>\",0]]</code><p><code>[[\"\"metrics.organic.count\",\">\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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 example: [\"metrics.paid.count\",\">\",0] [[\"metrics.organic.count\",\">\",50],\"and\",[\"metrics.organic.pos_1\",\"\",0]] [[\"\"metrics.organic.count\",\">\",50\"], \"and\", [[\"metrics.organic.pos_1\",\"\",0],\"or\",[\"metrics.organic.pos_2_3\",\"\",0]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "historical_serp_mode": { - "description": "data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live", - "type": "string" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned pages optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned pages optional field default value: 0 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages", - "type": "integer" - }, - "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 specify a sorting type example: [\"metrics.paid.etv,asc\"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"] default rule: [\"metrics.organic.count,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - }, - "target": { - "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_search_intent_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "keywords": [ + "login page", + "audi a7", + "elon musk", + "milk store new york" + ] + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "keywords": [ + "login page", + "audi a7", + "elon musk", + "milk store new york" + ] + } + ], + "properties": { + "keywords": { + "description": "<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "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" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "keywords": { - "description": "target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports these languages only; example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages Note: this endpoint currently supports the following languages only: Arabic, ar, Chinese(Traditional), zh-TW, Czech, cs, Danish, da, Dutch, nl, English, en, Finnish, fi, French, fr, German, de, Hebrew, he, Hindi, hi, Italian, it, Japanese, ja, Korean, ko, Malay, ms, Norwegian(Bokmål), nb, Polish, pl, Portuguese, pt, Romanian, ro, Russian, ru, Spanish, es, Swedish, sv, Thai, th, Ukrainian, uk, Vietnamese, vi, Bulgarian, bg, Croatian, hr, Serbian, sr, Slovenian, sl, Bosnian, bs, Greek, el, Hungarian, hu, Slovak, sk, Turkish, tr example: English", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_serp_competitors_live8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "item_types": [ + "organic" + ], + "keywords": [ + "phone" + ], + "language_name": "English", + "limit": 5, + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "item_types": [ + "organic" + ], + "keywords": [ + "phone" + ], + "language_name": "English", + "limit": 5, + "location_code": 2840 + } + ], + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"median_position\",\"in\",[1,10]]</code><p><code>[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]</code><p><code>[[\"domain\",\"not_like\",\"%wikipedia.org%\"],<br>\"and\",<br>[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "include_subdomains": { + "description": "<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>search results type</em><br>indicates type of search results included in the response<br>optional field<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "keywords": { + "description": "<em>keywords array</em><br><strong>required field</strong><br>the results will be based on the keywords you specify in this array<br>UTF-8 encoding;<br>the keywords will be converted to lowercase format;<br><strong>you can specify the maximum of 200 keywords</strong><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>", + "items": { + "type": "string" + }, + "type": "array" + }, + "language_code": { + "description": "<em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with <code>location_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", + "type": [ + "integer", + "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>the comma is used as a separator<br>example:<br><code>[\"avg_position,asc\"]</code><br>default rule:<br><code>[\"rating,desc\"]</code><br><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>[\"avg_position,asc\",\"etv,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"median_position\",\"in\",[1,10]] [[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]] [[\"domain\",\"not_like\",\"%wikipedia.org%\"], \"and\", [[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "include_subdomains": { - "description": "indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true", - "type": "boolean" - }, - "item_types": { - "description": "search results type indicates type of search results included in the response optional field possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "keywords": { - "description": "keywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; you can specify the maximum of 200 keywords learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "unique language identifier required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned domains optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with location_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains", - "type": "integer" - }, - "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 the comma is used as a separator example: [\"avg_position,asc\"] default rule: [\"rating,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"avg_position,asc\",\"etv,desc\"]", - "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" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "keywords" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_subdomains_live7 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "filters": [ + [ + "metrics.organic.pos_1", + "<>", + 0 + ], + "or", + [ + "metrics.organic.pos_2_3", + "<>", + 0 + ] + ], + "language_name": "English", + "location_code": 2840, + "target": "dataforseo.com" + } + ], + "properties": { + "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><br>example:<br><code>[\"metrics.paid.count\",\">\",0]</code><p><code>[[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]]</code><p><code>[[\"metrics.organic.count\",\">\",\"10\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"<>\",0],\"or\",[\"metrics.organic.pos_2_3\",\"<>\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "historical_serp_mode": { + "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>", + "type": [ + "string", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "item_types": { + "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": [ + "string", + "null" + ] + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", + "type": [ + "integer", + "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 specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array", + "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" + ] + }, + "target": { + "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>", + "type": "string" + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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 example: [\"metrics.paid.count\",\">\",0] [[\"metrics.paid.count\",\">\",0],\"and\",[\"metrics.paid.etv\",\">\",\"50\"]] [[\"metrics.organic.count\",\">\",\"10\"], \"and\", [[\"metrics.organic.pos_1\",\"\",0],\"or\",[\"metrics.organic.pos_2_3\",\"\",0]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide", - "items": {}, - "type": "array" - }, - "historical_serp_mode": { - "description": "data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live", - "type": "string" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "item_types": { - "description": "display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"] default value: [\"organic\", \"paid\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "language_code": { - "description": "language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords", - "type": "integer" - }, - "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 specify a sorting type example: [\"metrics.paid.etv,asc\"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"] default rule: [\"metrics.organic.count,desc\"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array", - "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" - }, - "target": { - "description": "domain required field the domain name of the target website the domain should be specified without https:// and www.", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "target" -] - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_labs_google_top_searches_live6 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "language_name": "English", + "limit": 3, + "location_code": 2840 + } +] - changed
Input schema / properties / body / items / anyOfPrevious value: -[ - { - "allOf": [ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "required": [ - "language_name" - ] - }, - { - "required": [ - "language_code" - ] - } - ] - } - ] - }, - { - "required": [ - "offset_token" - ] - } -]New value: +[ + { + "example": [ + { + "language_name": "English", + "limit": 3, + "location_code": 2840 + } + ], + "properties": { + "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>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"keyword_info.search_volume\",\">\",0]</code><p><code>[[\"keyword_info.search_volume\",\"in\",[0,1000]],<br>\"and\",<br>[\"keyword_info.competition_level\",\"=\",\"LOW\"]]</code><p><code>[[\"keyword_info.search_volume\",\">\",100],<br>\"and\",<br>[[\"keyword_info.cpc\",\"<\",0.5],<br>\"or\",<p>[\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "ignore_synonyms": { + "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code> only core keywords will be returned, all highly similar keywords will be excluded; <br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "include_clickstream_data": { + "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>", + "type": [ + "boolean", + "null" + ] + }, + "include_serp_info": { + "description": "<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>", + "type": [ + "boolean", + "null" + ] + }, + "language_code": { + "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "limit": { + "description": "<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>", + "type": [ + "integer", + "null" + ] + }, + "location_code": { + "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">2840</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">United Kingdom</code>", + "type": "string" + }, + "offset": { + "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<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>offset 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 10,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 except <code>limit</code> will not be taken into account when processing a task.<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 type<br>example:<br><code>[\"keyword_info.competition,desc\"]</code><br>default rule:<br><code>[\"keyword_info.search_volume,desc\"]</code><br><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>[\"keyword_info.search_volume,desc\",\"keyword_info.cpc,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" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like,as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide", - "items": {}, - "type": "array" - }, - "ignore_synonyms": { - "description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false", - "type": "boolean" - }, - "include_clickstream_data": { - "description": "include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article", - "type": "boolean" - }, - "include_serp_info": { - "description": "include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false", - "type": "boolean" - }, - "language_code": { - "description": "language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English", - "type": "string" - }, - "limit": { - "description": "the maximum number of returned keywords optional field note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request default value: 1000 maximum value: 1000", - "type": "integer" - }, - "location_code": { - "description": "location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840", - "type": "integer" - }, - "location_name": { - "description": "full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom", - "type": "string" - }, - "offset": { - "description": "offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center", - "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 type example: [\"keyword_info.competition,desc\"] default rule: [\"keyword_info.search_volume,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"keyword_info.search_volume,desc\",\"keyword_info.cpc,desc\"]", - "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" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - changed
Input schema / requiredPrevious value: -[ - "body" -]New value: +[] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
search17 fields changed- added
Input schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema" - removed
Input schema / properties / category / anyOfRemoved value: -[ - { - "enum": [ - "seo", - "finance", - "social", - "search", - "sales", - "mail" - ], - "type": "string" - }, - { - "type": "null" - } -] - removed
Input schema / properties / category / defaultRemoved value: -null - changed
Input 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.)" - added
Input schema / properties / category / enumAdded value: +[ + "seo", + "finance", + "social", + "search", + "sales", + "mail" +] - added
Input schema / properties / category / typeAdded value: +"string" - added
Input schema / properties / known_fieldsAdded value: +{ + "additionalProperties": true, + "default": {}, + "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.", + "type": "object" +} - changed
Input schema / properties / limit / descriptionPrevious value: -"Maximum candidates, 1-10"New value: +"Maximum number of additional direct tool candidates." - added
Input schema / properties / limit / maximumAdded value: +20 - added
Input schema / properties / limit / minimumAdded value: +1 - added
Input 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 +} - changed
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." - added
Input schema / properties / query / maxLengthAdded value: +2000 - added
Input schema / properties / query / minLengthAdded value: +1 - added
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" +} - added
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" + } + } +} - added
Output schema / requiredAdded value: +[ + "next_steps_guidance", + "search_id", + "session_id", + "tools" +]
- Changed
use1 field changed- changed
Input 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"
1 tool update
- Changed
get_details1 field changed- added
Input 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" +}
12 tool updates
- Changed
post_dataforseo_labs_amazon_product_kw_overlap_live1 field changed- changed
Input 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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"avg_position\",\" for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide"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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"avg_position\",\"<\", 10] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide"
- Changed
post_dataforseo_labs_amazon_related_keywords_live1 field changed- changed
Input schema / properties / body / items / properties / ignore_synonyms / descriptionPrevious value: -"ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false"New value: +"ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen"
- Changed
post_dataforseo_labs_google_bulk_traffic_estimation_live1 field changed- changed
Input schema / properties / body / items / properties / ignore_synonyms / descriptionPrevious value: -"ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false"New value: +"ignore highly similar keywords optional field if set to_true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false"
- Changed
post_dataforseo_labs_google_categories_for_domain_live1 field changed- changed
Input schema / properties / body / items / properties / include_clickstream_data / descriptionPrevious value: -"include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article"New value: +"include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to_true, you will receive clickstream_etv, clickstream_gender_distribution, and_clickstream_age_distribution_fields with clickstream data in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article n"
- Changed
post_dataforseo_labs_google_domain_rank_overview_live1 field changed- changed
Input schema / properties / body / items / properties / ignore_synonyms / descriptionPrevious value: -"ignore highly similar keywords optional field if set to true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value: false"New value: +"ignore highly similar keywords optional field if set to_true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms default value: falsen"
- Changed
post_dataforseo_labs_google_historical_bulk_traffic_live1 field changed- changed
Input schema / properties / body / items / properties / ignore_synonyms / descriptionPrevious value: -"ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false"New value: +"ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen"
- Changed
post_dataforseo_labs_google_keyword_ideas_live3 fields changed- changed
Input schema / properties / body / items / properties / closely_variants / descriptionPrevious value: -"search mode optional field if set to true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: false"New value: +"search mode optional field if set to_true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: falsen" - changed
Input 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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\" for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide"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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide" - changed
Input schema / properties / body / items / properties / ignore_synonyms / descriptionPrevious value: -"ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false"New value: +"ignore highly similar keywords optional field if set to_true only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen"
- Changed
post_dataforseo_labs_google_keyword_suggestions_live1 field changed- changed
Input 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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\" for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide"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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]][[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide"
- Changed
post_dataforseo_labs_google_keywords_for_categories_live1 field changed- changed
Input 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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\" for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide"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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide"
- Changed
post_dataforseo_labs_google_kw_for_site_live1 field changed- changed
Input schema / properties / body / items / properties / include_clickstream_data / descriptionPrevious value: -"include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article"New value: +"include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to_true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article n\""
- Changed
post_dataforseo_labs_google_related_keywords_live1 field changed- changed
Input 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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_data.keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_data.keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_data.keyword_info.cpc\",\" for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide"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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_data.keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_data.keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_data.keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_data.keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide"
- Changed
post_dataforseo_labs_google_top_searches_live1 field changed- changed
Input 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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like,as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\" for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide"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, match, not_match, ilike, not_ilike, like,not_like you can use the % operator with like and not_like,as well as ilike and not_ilike to match any string of zero or more characters example: [\"keyword_info.search_volume\",\">\",0] [[\"keyword_info.search_volume\",\"in\",[0,1000]], \"and\", [\"keyword_info.competition_level\",\"=\",\"LOW\"]] [[\"keyword_info.search_volume\",\">\",100], \"and\", [[\"keyword_info.cpc\",\"<\",0.5], \"or\", [\"keyword_info.high_top_of_page_bid\",\"<=\",0.5]]] for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide"
51 tool updates
- First observed
batch_use - First observed
get_ahrefs_domain_rating - First observed
get_ahrefs_site_metrics - First observed
get_dataforseo_labs_available_filters - First observed
get_dataforseo_labs_google_available_history - First observed
get_dataforseo_labs_google_categories_for_kw_languages - First observed
get_dataforseo_labs_status - First observed
get_details - First observed
get_semrush_domain_organic_keywords - First observed
get_semrush_domain_overview - First observed
get_semrush_domain_paid_keywords - First observed
get_semrush_domain_rank_history - First observed
get_semrush_domain_vs_domain - First observed
get_semrush_organic_competitors - First observed
get_semrush_url_organic_keywords - First observed
list_categories - First observed
post_dataforseo_labs_amazon_bulk_volume_live - First observed
post_dataforseo_labs_amazon_product_competitors_live - First observed
post_dataforseo_labs_amazon_product_kw_overlap_live - First observed
post_dataforseo_labs_amazon_product_rank_overview_live - First observed
post_dataforseo_labs_amazon_ranked_keywords_live - First observed
post_dataforseo_labs_amazon_related_keywords_live - First observed
post_dataforseo_labs_apple_app_competitors_live - First observed
post_dataforseo_labs_apple_app_intersection_live - First observed
post_dataforseo_labs_apple_bulk_app_metrics_live - First observed
post_dataforseo_labs_apple_keywords_for_app_live - First observed
post_dataforseo_labs_google_app_competitors_live - First observed
post_dataforseo_labs_google_app_intersection_live - First observed
post_dataforseo_labs_google_bulk_app_metrics_live - First observed
post_dataforseo_labs_google_bulk_keyword_difficulty_live - First observed
post_dataforseo_labs_google_bulk_traffic_estimation_live - First observed
post_dataforseo_labs_google_categories_for_domain_live - First observed
post_dataforseo_labs_google_categories_for_kw_live - First observed
post_dataforseo_labs_google_domain_rank_overview_live - First observed
post_dataforseo_labs_google_historical_bulk_traffic_live - First observed
post_dataforseo_labs_google_historical_keyword_data_live - First observed
post_dataforseo_labs_google_historical_rank_live - First observed
post_dataforseo_labs_google_keyword_ideas_live - First observed
post_dataforseo_labs_google_keyword_overview_live - First observed
post_dataforseo_labs_google_keyword_suggestions_live - First observed
post_dataforseo_labs_google_keywords_for_app_live - First observed
post_dataforseo_labs_google_keywords_for_categories_live - First observed
post_dataforseo_labs_google_kw_for_site_live - First observed
post_dataforseo_labs_google_related_keywords_live - First observed
post_dataforseo_labs_google_relevant_pages_live - First observed
post_dataforseo_labs_google_search_intent_live - First observed
post_dataforseo_labs_google_serp_competitors_live - First observed
post_dataforseo_labs_google_subdomains_live - First observed
post_dataforseo_labs_google_top_searches_live - First observed
search - First observed
use
Publisher details
- Operator
- AIsa · Publisher source
- Operator website
- https://aisa.one
- Vendor relationship
- Independent
- Documentation
- https://mcp.aisa.one/servers
- Trust center
- Not available
- Restrictions
- No paid plan, admin approval, regional limit or custom OAuth app is needed to connect. Sign-in is OAuth against auth.aisa.one with dynamic client registration (RFC 7591), or an Authorization: Bearer AIsa API key. search, get_details and list_categories are free. use and batch_use are billed per call to the caller's own AIsa key, and max_price_usd refuses anything above a cap before any spend. Some operations are subscription-only on the gateway and answer 402 without the Hive GTM Growth plan.
Related MCP Connectors
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
Your agent needs to know what people actually search — volume, ideas, how hard the term is, and whether interest is rising or was a spike last March. **What you can ask for** • "What is the monthly volume and difficulty for these 200 keywords?" • "Give me keyword ideas around this seed, with questions people ask." • "Which keywords does this competitor rank for that we do not?" • "Is interest in this term growing, and where?" • "What does this page already rank for?" **How to use it** Point any MCP client at https://mcp.aisa.one/seo-keywords/mcp and sign in with OAuth — there is no key to create or paste. 49 tools: Google and Bing volume and suggestions, keywords for a site or a URL, clickstream volumes, Google Trends and Ads traffic estimates, plus Semrush difficulty, question keywords, broad match and paid keywords, and Similarweb's keyword and landing page sets. **Why this rather than the source** Three sources for the same number, so a suspicious volume can be checked rather than believed. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Size the demand here, then ask the same agent who ranks for it and who links to them — 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 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 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.
Related MCP Servers
- AlicenseAqualityCmaintenanceWeb intelligence MCP server for AI agents. 7 tools for SERP analysis, competitor research, market trends, content gap analysis, keyword insights, audience discovery, and citation tracking.72AGPL 3.0
- AlicenseNot gradedqualityCmaintenanceAgent-first SEO toolkit with 24 MCP tools for keyword research, rank tracking, site audits up to 50k pages, competitor analysis, content gap detection, domain reputation, backlink intelligence, Google Search Console integration, and AI-powered strategy generation with Claude, GPT, and Ollama. SQLite-backed and bring-your-own-key.MIT
- AlicenseNot gradedqualityBmaintenanceEnables AI agents to perform live Google SERP searches, run on-page and full-site SEO audits with prioritized fixes, and check brand visibility in AI answer engines via four MCP tools.MIT
- AlicenseAqualityBmaintenanceSelf-hostable SEO data MCP server: keyword metrics, Google and Bing SERP, competitors, keyword gap, Google Maps businesses and a Local Market Check package via DataForSEO, paid per call with x402 (USDC on Base). Free tools list services, validate input and give daily free samples.26MIT
Glama MCP Gateway
Add one secure layer between your agents and this server.