AIsa App Store Data
Server Details
Your agent needs app-store data — what an app looks like on the App Store and Google Play, what reviewers say, and what ranks for a search in a given country.
What you can ask for • "What does this app's store listing look like, and how is it rated?" • "Pull recent reviews for this app and group the complaints." • "What apps rank for this search term in Japan?" • "List the top apps in this category on both stores." • "Compare this app's listing on iOS and Android."
How to use it Point any MCP client at https://mcp.aisa.one/seo-apps/mcp and sign in with OAuth — there is no key to create or paste. 37 tools: Apple App Store and Google Play app info, app lists, category listings, reviews and store search results, in live and queued forms, with categories, languages and locations for each.
It is also a door to the rest The same login reaches 26 sources and 580+ operations. Read the store listing here, then ask the same agent what the app's website ranks for — 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 44 tools
The set contains genuine near-duplicates: get_dataforseo_app_apple_categories and get_dataforseo_app_apple_app_listings_categories are both described as 'a full list of app categories available on App Store' (same for Google), and every fetch/post pair (app_info_fetch vs app_info_submit, app_list_fetch vs app_list_submit, app_reviews_fetch vs app_reviews_submit) targets the same data with only Live-vs-Task semantics implied. The three *_html tools for Google carry the placeholder description 'Description of the fields for sending a request:', giving an agent no basis for choosing between them and their non-HTML twins. Platform prefixes (apple/google) do help, but an agent has many coin-flips here.
Everything is snake_case, but there are three incompatible naming families: DataForSEO mirrors (get_dataforseo_app_*, post_dataforseo_app_*, post_dataforseo_labs_*), light AIsa verbs (search, use, account, list_categories), and batch_* helpers. The get_/post_ distinction encodes Live-vs-Task submission rather than a normal read/write verb, which is not self-evident from the names.
44 tools far exceeds a reasonable surface for an app-store data server, and much of the bulk is mechanical duplication (fetch + submit + html variants across two platforms) rather than distinct capability. A router with search/batch_get_schema/batch_quote/batch_use layered on top of 30+ direct endpoints is contradictory design and inflates the count further.
Core domain coverage is broad: app info, top charts, keyword search rankings, reviews, categories/languages/locations, plus Labs competitor/keyword-intersection/bulk-metrics endpoints for both App Store and Google Play. However, the task-based submit endpoints have no companion task_get/tasks_ready tool to retrieve results, and there is no keyword-volume or historical rank-tracking endpoint, leaving notable dead ends.
Available Tools
44 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_dataforseo_app_apple_app_info_fetchGet Apple App Info Results by idBRead-onlyIdempotentInspect
This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, images, and other data. The results are specific to the app_id parameter specified in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
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 description adds the returned payload contents and a (free) price note, but discloses no auth, rate-limit, or workflow behavior beyond that; with annotations carrying the safety burden, 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?
The core is two front-loaded sentences with no wasted prose. The appended aisa-pricing HTML block is boilerplate noise but is clearly delimited and not part of the semantic 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?
Output schema exists so return values needn't be re-explained (though the description does), and the single parameter is well covered. The key omission is the submit/fetch workflow context — an agent needs a task id from post_dataforseo_app_apple_app_info_submit, which is never mentioned.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the schema fully documents the 'id' task-identifier (UUID, valid 30 days), so the baseline is 3. The description's reference to an 'app_id parameter specified in the POST request' does not match the actual 'id' task identifier and adds mild confusion rather than 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?
States a specific verb (fetch/provide) and resource (Apple app info results), and enumerates the returned fields (ID, icon, description, reviews count, rating, images). However, it never distinguishes itself from its submit counterpart (post_dataforseo_app_apple_app_info_submit) or the Google variant, and its 'specified in a POST request' phrasing muddies what is actually a results-fetch-by-task-id.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of the two-step submit-then-fetch workflow, and no reference to any sibling or alternative. The agent is left to infer that this retrieves results of a previously submitted task.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_apple_app_list_fetchGet Apple App List Results by idBRead-onlyIdempotentInspect
This endpoint will provide you with a list of applications published in the top app charts on the App Store platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
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, destructiveHint=false and openWorldHint, so the safety profile is covered by structured data. The description adds genuine context that results are scoped to the app_collection/location/language of the originating POST and states the published price is $0, but it omits the behavioral facts that matter here (that the call is a poll on an async task and that the id is only usable for 30 days).
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 is returned and end with the scoping tie-back to the POST parameters; no padding in the prose. The injected pricing boilerplate adds length without agent-relevant selection value, keeping it short of a 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values need not be spelled out, and annotations cover safety, but the description still omits the essential workflow contract: this must be called with a task id produced by the matching submit endpoint. Without that link an agent cannot tell this retrieval tool apart from its submit counterpart or the Google equivalent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the sole parameter is fully documented there (UUID task identifier, 30-day validity window). The description adds no meaning about the id parameter itself, only about the data it returns, so the baseline 3 for high-coverage schemas 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?
States a specific verb and resource: returns the list of applications in the App Store top charts, enumerating returned fields (app IDs, ratings, prices, titles). It does not differentiate itself from the near-identically named Google sibling (get_dataforseo_app_google_app_list_fetch), and it never states that this is the result-retrieval half of an async submit/fetch pair keyed by task id, which is the single most important distinguishing fact.
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 only implied through the phrase 'the app_collection as well as the location and language parameters specified in the POST request', which hints that a prior POST submission is required. It never says when to call this versus post_dataforseo_app_apple_app_list_submit or the live variants, and gives no exclusions or prerequisites explicitly.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_apple_app_listings_categoriesList of App Store Listings Categories for App Data APIBRead-onlyIdempotentInspect
This endpoint will provide you with a full list of app categories available on Apple App Store.
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=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety and idempotency profile is fully covered structurally. The description adds only the pricing/billing note, which is mildly useful context; it says nothing about rate limits, caching, or result freshness beyond 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?
The purpose sentence is front-loaded and wastes no words. The appended pricing block is boilerplate that dilutes the definition slightly but is short and clearly delimited.
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?
The tool is a simple zero-param read with an output schema, so return values need not be explained. The main gap is disambiguation from the near-identical sibling get_dataforseo_app_apple_categories, which the description does not address.
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 clarify beyond the schema; baseline for a parameterless tool is 4. The description correctly implies a no-input listing call.
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 ('provide a full list') and resource ('app categories available on Apple App Store'), which cleanly separates it from the Google variant. However, it does not distinguish itself from the very similarly named sibling get_dataforseo_app_apple_categories, leaving the agent unable to tell the two apart from the description 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?
No guidance on when to call this versus alternatives, and there are several close siblings (get_dataforseo_app_apple_categories, list_categories, the Google listings-categories tool). The description offers no conditions, prerequisites, or routing hints, so an agent must guess.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_apple_app_reviews_fetchGet Apple App Reviews Results by idARead-onlyIdempotentInspect
This endpoint will provide you with feedback data on applications listed on the App Store platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
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, destructiveHint=false and openWorldHint, covering the safety profile. The description adds that output includes ratings, review content, reviewer profiles and dates, but omits behavioral facts like task retention window, pagination, or auth requirements, so it adds only modest context beyond the structured data.
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 content is a single front-loaded sentence that leads with the endpoint's output. The appended pricing comment block is boilerplate noise, but the core description is compact and earns its place.
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 needn't explain return values, and annotations cover the safety profile. For a one-parameter fetch-by-id tool the coverage is nearly complete; the one gap is the absence of an explicit link to the corresponding submit tool, which the sibling naming makes important.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single 'id' parameter is fully documented in the schema (UUID task identifier, usable for 30 days). The description adds the useful nuance that results are scoped by app_id, location and language from the originating POST, though those are not parameters of this tool, which risks minor confusion.
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 App Store review feedback data (ratings, content, reviewer profile, dates). It also reveals the retrieval pattern by noting results are scoped to parameters 'specified in the POST request', which implicitly ties it to its submit sibling. However, it never names the App-Store-vs-Google or fetch-vs-submit distinction explicitly, so an agent must infer the routing.
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 or when-not statement, and no sibling is named. The only guidance is the indirect mention that results reflect the POST request parameters, which implies the two-step submit-then-fetch workflow but leaves the agent to infer that this tool is the retrieval half of post_dataforseo_app_apple_app_reviews_submit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_apple_app_searches_fetchGet Apple App Searches Results by idBRead-onlyIdempotentInspect
This endpoint will provide you with a list of apps ranking on the App Store for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
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 the safety profile is covered. The description adds that results are scoped to keyword, location, and language, which is useful behavioral context, but says nothing about pagination, result ordering, or how the underlying task lifecycle affects availability.
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 effective sentences front-load the resource and the returned field set; the only padding is the injected pricing comment block, which is not the author's descriptive prose. Structure is otherwise tight and readable.
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 spelled out, and the description nonetheless lists them. However, for an asynchronous fetch-by-id tool in a family full of submit/fetch pairs, the missing explanation of how the id is obtained and how this differs from the submit tool leaves a real workflow 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?
There is a single parameter (id) with 100% schema description coverage, including the 30-day retention rule, so the schema already carries the semantics. The description adds nothing about the id, making the baseline 3 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 ('provide a list of apps ranking on the App Store'), but it never frames the tool as a fetch-by-id retrieval of a previously submitted task. It reads as if the endpoint itself takes a keyword/location/language, which is the behavior of the sibling post_...searches_submit tool. Sibling differentiation against the submit counterpart is therefore weak.
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 phrase 'specified in a POST request' implies this tool pairs with a submit call, but it never says 'use the id returned by X' or when to choose this fetch over the submit/live alternative. Usage is only implied, not stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_apple_categoriesList of Apple App Categories for App Data APIBRead-onlyIdempotentInspect
This endpoint will provide you with a full list of app categories available on App Store.
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 only a usage-based billing note (default ~$0.012, not a fixed price), which is genuine cost context not present in annotations, but says nothing about rate limits, result size, or 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 functional sentence is front-loaded and wastes nothing. The appended pricing block is boilerplate and lengthens the text, but it is clearly delimited and carries usable cost 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 that already has an output schema, the description need not explain return values, and it correctly does not. The only real omission is usage context relative to the near-named sibling, which keeps it from a 5.
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 no parameter semantics to document and the baseline of 4 applies. Nothing in the description is needed to compensate for schema gaps.
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 the full list of app categories available on the App Store. That is clear and unambiguous on its own. It does not, however, distinguish itself from the sibling get_dataforseo_app_apple_app_listings_categories, which sounds closely related, 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 or when-not-to-use guidance and no alternative named. The intended use (fetching category identifiers to filter other App Store calls) must be inferred entirely from the tool name. It also does not explain the relationship to the similarly named listings-categories sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_apple_languagesList of Apple Languages for App Data APIBRead-onlyIdempotentInspect
By calling this endpoint you will receive the list of Apple languages supported in App Data 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?
Rich annotations (readOnlyHint, idempotentHint, openWorldHint, destructiveHint=false) already establish this as a safe, side-effect-free read. The description adds only billing context ('usage-based billing; default estimate $0.012 USD, not a fixed price'), which is genuinely useful but is injected boilerplate rather than tool-specific behavior. No return-shape or pagination notes, though an output schema exists.
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 a single front-loaded sentence with no wasted words. The appended pricing block is somewhat verbose and not relevant to invocation, slightly diluting 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?
With an output schema present and annotations covering the safety profile, the description needn't explain return values. It states exactly what the endpoint yields, which is sufficient for a parameterless reference-list call; only explicit sibling routing 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 per the baseline a 4 applies. There is nothing for the description to compensate for, and schema coverage is nominally 100%.
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: 'receive the list of Apple languages supported in App Data API.' The 'Apple' qualifier lets an agent distinguish it from the sibling get_dataforseo_app_google_languages without opening either schema, though it never names that sibling explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to call this versus the many sibling reference/list endpoints (google_languages, apple_locations, apple_categories). The purpose implies usage but nothing states prerequsites, sequencing, or when-not-to-use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_apple_locationsList of Apple Locations for App Data APIBRead-onlyIdempotentInspect
By calling this endpoint you will receive the list of Apple locations supported in App Data API. for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/locations/?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 declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile needs no repetition. The description does add one genuine behavioral fact beyond the annotations — that this is a billing-bearing call with a default estimate of $0.012 — but it discloses nothing about the shape, size, or stability of the returned location list.
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 lead sentence is slightly wordy ('By calling this endpoint you will receive...') where 'Returns the list of Apple locations supported in App Data API' would be tighter. The doc-link sentence and the injected pricing block are short but neither is front-loaded with the decisive information an agent needs.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, the description need not explain the returned fields, and with zero parameters there is no input burden. Annotations cover the safety profile, so the remaining obligations are met; only the missing cross-reference to downstream endpoints keeps it from a 5.
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; the baseline for a parameterless tool is 4. Nothing in the description misleads about inputs.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource: it returns 'the list of Apple locations supported in App Data API.' An agent can distinguish it from get_dataforseo_app_google_locations by the Apple qualifier, but it never explicitly contrasts itself with its closest siblings (languages, categories), so the differentiation is inferred rather than stated.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance and no mention of alternatives. It does not say, for example, that the returned location codes are the valid inputs for the *_live/_submit App Data endpoints, which is the primary reason an agent would call it. Usage is only implied by the endpoint name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_app_info_fetchGet Google App Info Results by idBRead-onlyIdempotentInspect
This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, number of installs, images, and other data. The results are specific to the app_id parameter specified in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
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 adds that results are scoped to a prior POST request, hinting at the async task model, but does not describe pagination, freshness, or the retrieval window beyond what the schema states.
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 prose is short. The enumeration of return fields is somewhat redundant given an output schema exists, and the pricing block is boilerplate, but overall it is tight.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and rich annotations, the core call mechanics are adequately covered. What is missing is the lifecycle context that matters for this async fetch tool: that it depends on a prior submission and that the id is valid only for a limited window (the latter appears only in the schema, not the description).
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single 'id' parameter is fully documented as a UUID task identifier. However, the description calls out an 'app_id parameter specified in the POST request', which conflates the task identifier this tool consumes with a different parameter from the upstream POST, risking agent confusion.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a clear verb and resource: it retrieves information about a mobile application and enumerates the fields returned (ID, icon, description, reviews count, rating, installs, images). The 'fetch by id' pattern is clear, though it never explicitly distinguishes itself from the Apple or _html sibling variants, 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?
No explicit when-to-use or when-not-to-use guidance. It vaguely references 'the mobile application specified in a POST request' but never tells the agent that this is an async result-fetch tool requiring the task id from post_dataforseo_app_google_app_info_submit. The agent must infer the two-step workflow entirely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_app_info_fetch_htmlGet Google App Info HTML Results by idCRead-onlyIdempotentInspect
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time |
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 safety (readOnlyHint, idempotentHint, destructiveHint=false) and open-world scope, so the description carries a lighter burden. It adds a genuinely useful behavioral fact the annotations lack — the $0 reference cost per successful request — but says nothing about the required task-id lifecycle beyond what the schema states.
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 only real content is auto-injected pricing boilerplate, and the leading sentence is an empty header rather than a front-loaded statement of purpose. Space is spent without communicating anything an agent can act on.
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 sole parameter is covered by the schema. However, for a fetch-results tool that has a near-identical non-HTML sibling, the total absence of purpose and disambiguation leaves the definition 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?
Schema description coverage is 100% and there is a single required 'id' parameter fully documented in the schema (UUID format, 7-day validity window). The description's 'Description of the fields for sending a request' phrasing promises parameter detail it never delivers, so it adds nothing beyond the schema — the baseline 3.
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 'Description of the fields for sending a request:' — a generic header that never states what the tool actually does. Purpose must be inferred entirely from the name/title, so an agent gets no verb+resource statement from the description itself.
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. The agent is not told how this HTML-fetch tool relates to the sibling get_dataforseo_app_google_app_info_fetch (non-HTML) or get_dataforseo_app_google_app_list_fetch_html.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_app_list_fetchGet Google App List Results by idARead-onlyIdempotentInspect
This endpoint will provide you with a list of applications published in the top charts on the Google Play platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
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 still adds value by disclosing that the returned list is scoped to the app_collection/location/language chosen at POST time, which the agent cannot infer from the schema or annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core description is a single front-loaded sentence that names the resource and the result contents with no filler. The trailing pricing marker is injected boilerplate rather than authored text, so it does not count against the 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-value explanation is not needed, and annotations cover the safety profile; the parameter is fully documented in the schema. The remaining gap is that the relationship to the corresponding submit tool is only hinted at, not stated.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and there is only one parameter (id), whose UUID format and 30-day reuse window are fully documented in the schema. The description adds no syntax or format detail beyond what the schema already provides, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: it returns 'a list of applications published in the top charts on the Google Play platform' with concrete fields (app IDs, ratings, prices, titles). It is clearly the retrieval half of the Google app-list pair, but it never names the sibling it could be confused with (get_dataforseo_app_google_app_list_fetch_html, get_dataforseo_app_google_app_listings_categories) or the POST that produces the id.
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 phrase 'specific to the app_collection as well as the location and language parameters specified in the POST request' implies this is a second-step fetch after a submit call, which is useful workflow guidance. However, no sibling is named and there is no explicit when-to-use/when-not-to-use statement.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_app_list_fetch_htmlGet Google App List HTML Results by idCRead-onlyIdempotentInspect
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time |
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, destructiveHint=false, and openWorldHint, so the safety profile is covered. The only extra content is a generic published-price note ($0 per successful request), which is marginal and not tool-specific; nothing about retrieval windows, task state requirements, or failure modes is added.
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 almost none of its length earns its place: the opening sentence is a broken placeholder and the pricing comment block is boilerplate noise rather than front-loaded purpose or constraints.
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 plus the schema cover behavior and the parameter. However, for a fetch-by-id endpoint competing with ~40 siblings, an entirely absent statement of purpose and prerequisites leaves the agent unable to select it 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 100% for the single 'id' parameter, including the UUID format and the 7-day usability window, so the schema carries the full burden. The description adds nothing beyond it, which is the baseline-3 case.
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 body text is a placeholder header ('Description of the fields for sending a request:') plus a pricing block; it never states what the tool does. Only the name/title hint that it fetches HTML results for a Google app-list task, and nothing distinguishes it from the sibling get_dataforseo_app_google_app_list_fetch.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of the HTML vs non-HTML sibling, and no note about the 7-day result-retention window that determines whether this call is even viable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_app_listings_categoriesList of Google App Listings Categories for App Data APIBRead-onlyIdempotentInspect
This endpoint will provide you with a full list of app categories available on Google Play.
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=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is fully covered. The description adds only that the result is a full/complete list (no pagination or filtering), plus billing context, which is modest added value.
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 a single, front-loaded statement with no waste. The trailing pricing block is boilerplate rather than functional description, slightly diluting an otherwise tight definition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter, read-only lookup with an output schema present, the description says enough: what it returns and that it is the full set. The one gap is disambiguation from the sibling categories endpoints, which the agent must resolve 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?
The tool takes zero parameters, so per the rubric the baseline is 4. The description correctly implies a no-argument call, and there are no parameter semantics left to explain.
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: returning a full list of app categories on Google Play. However, it does not differentiate itself from the closely-named sibling get_dataforseo_app_google_categories, leaving ambiguity about which 'categories' endpoint is intended.
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, no prerequisites, and no mention of the alternative get_dataforseo_app_google_categories. The only contextual content is an auto-injected pricing note, which addresses cost rather than usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_app_reviews_fetchGet Google App Reviews Results by idBRead-onlyIdempotentInspect
This endpoint will provide you with feedback data on applications listed on the Google Play platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
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 read-only, idempotent, non-destructive behavior, so the bar is lower. The description adds that results are scoped to app_id/location/language from the original POST, which is useful, but offers no rate-limit, pagination, or freshness detail.
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 that front-load the resource and return fields, plus a pricing block. Efficient, though the pricing HTML comment adds noise that isn't agent-facing.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values needn't be explained, and annotations cover safety. Still, for a task-result retrieval endpoint the description omits the crucial workflow step (you must first call the reviews submit endpoint) and any handling of pending/failed tasks.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and already explains the UUID task id and 30-day retrieval window, so the schema does the heavy lifting. The description adds only the note that results reflect the original request's app_id/location/language.
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 (fetch) and resource (Google Play app reviews) and enumerates the returned fields. It doesn't explicitly name the sibling post_dataforseo_app_google_app_reviews_submit that generates the task, but the 'by id' title implies a follow-up retrieval.
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 this is a retrieval keyed on a task id issued after a POST submit, but it never states when to use this versus the submit/live endpoints. Usage is only inferable from the 'id' parameter semantics.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_app_searches_fetchGet Google App Searches Results by idCRead-onlyIdempotentInspect
This endpoint will provide you with a list of apps ranking on Google Play for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
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 adds that results are scoped to keyword/location/language, but this describes the underlying data rather than this tool's behavior. It does not disclose that results are only retrievable for a limited window, though that detail lives 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?
Two sentences plus a boilerplate pricing block; the payload is front-loaded and not bloated. However, the reference to a 'POST request' is misleading for a fetch endpoint and consumes space without earning it, weakening the structure.
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. For an async task-retrieval tool, though, the description omits the essential submit-first dependency and the 30-day retrieval window (only present in the schema), leaving the agent short of what it needs to invoke 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?
With a single parameter at 100% schema description coverage, the schema fully documents the 'id' field, including its UUID format and 30-day validity. The description adds no parameter-level meaning beyond what the schema provides, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear resource (apps ranking on Google Play for a keyword) and lists returned fields, so the general purpose is discernible. However, it frames the operation around a 'POST request' rather than the fetch-by-task-id action the name and title imply, which blurs what this specific tool actually does. It also does not distinguish itself from the _html sibling or from the submit sibling that actually issues the POST.
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. Critically, it never explains that this fetch endpoint requires a task id produced by post_dataforseo_app_google_app_searches_submit, nor when to prefer it over the _html variant. The agent must infer the whole submit-then-fetch workflow.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_app_searches_fetch_htmlGet Google App Searches HTML Results by idDRead-onlyIdempotentInspect
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time |
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 structurally. The description adds only a pricing note ($0 USD per successful request, account-specific pricing may differ), which is a genuine behavioral detail but irrelevant to invoking the tool correctly; nothing is said about async task retrieval, the 7-day result window, or HTML vs JSON output.
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 brevity is the result of having no content rather than of discipline. The leading sentence is a truncated header that promises field descriptions it never delivers, and the pricing block is unrelated boilerplate.
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 though an output schema exists and return values needn't be explained, the description leaves the agent with no notion of what the tool fetches, which task id it accepts, or how it differs from the ~40 similarly named siblings in Apple/Google and html/non-html permutations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With a single required parameter and 100% schema description coverage, the schema already documents the UUID task id and its 7-day reusability window. The description adds no syntax, format, or constraint beyond the schema, so this sits at the baseline 3.
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. "Description of the fields for sending a request:" is a dangling header with no content, and the pricing boilerplate says nothing about fetching HTML Google app search results by task id. The name/title carry the entire meaning; the description is effectively missing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus the sibling post_dataforseo_app_google_app_searches_submit (which likely creates the task) or the non-HTML get_dataforseo_app_google_app_searches_fetch variant. No prerequisites, no context, no alternatives mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_categoriesList of Google App Categories for App Data APIBRead-onlyIdempotentInspect
This endpoint will provide you with a full list of app categories available on Google Play.
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, destructiveHint=false, and openWorldHint, so the safety profile is fully covered. The description adds one genuinely useful operational disclosure – usage-based billing at roughly $0.012 per request – but says nothing about response shape, result size, or whether the list is paginated.
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 a single front-loaded sentence, which is good. The injected aisa-pricing comment block adds several lines of generator boilerplate whose only real payload is the cost 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?
For a no-argument list endpoint with an output schema already describing the return shape, the description covers what the tool yields. Minor gaps are whether the list is complete/static and how pricing is actually settled.
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 bears no parameter-documentation burden and the baseline is 4. Nothing in the text conflicts with the empty 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 (provide a full list) and resource (app categories on Google Play), so an agent can distinguish it from the sibling get_dataforseo_app_apple_categories by platform. It stops short of explicitly naming that sibling or otherwise framing the Apple/Google split.
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 the sibling list endpoints (apple_categories, google_languages, list_categories) an agent might confuse it with. The only implied usage is that it returns the category catalog.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_languagesList of Google Languages for App Data APIARead-onlyIdempotentInspect
By calling this endpoint you will receive the list of Google languages supported in App Data 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 covered. The description adds genuinely useful behavioral context by disclosing usage-based billing with a default request estimate ($0.012 USD) and noting that account-specific pricing may differ, but it says nothing beyond that about the call itself.
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 wastes no words. The appended pricing block is template boilerplate but carries real information (cost estimate), so it earns its place, though it visually interrupts the definition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no parameters and an existing output schema, the description does not need to explain return values, and annotations cover the read-only/idempotent safety profile. Combined with the pricing disclosure, this is nearly complete, with the only gap being the absence of explicit guidance on when to call it versus its many siblings.
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 are no parameter semantics for the description to clarify. Baseline 4 applies, and nothing in the text misrepresents the (empty) input surface.
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 the list of Google languages supported in the App Data API. This clearly distinguishes it from the similarly-named Apple sibling (get_dataforseo_app_apple_languages) by naming the platform, though it does not explicitly call out the sibling or the related google_locations endpoint.
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 only implied: an agent infers this is a reference-lookup endpoint for enumerating valid Google language values before calling other App Data tools. There is no explicit when-to-use statement, no mention of alternatives like the Apple or locations endpoints, and no prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dataforseo_app_google_locationsList of Google Locations for App Data APIBRead-onlyIdempotentInspect
By calling this endpoint you will receive the list of Google locations supported in App Data 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 by structured data. The description adds only a pricing/cost note (usage-based billing), which is modestly useful context. With rich annotations the lower bar applies, so a baseline 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?
The functional content is a single front-loaded sentence with no waste. The appended aisa-pricing block is boilerplate noise, but it is clearly demarcated and does not obscure the core statement. Slightly less than ideal because of that inserted billing text.
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 list endpoint with an output schema present, the description need not explain return values or inputs. The statement of what is returned is sufficient for correct invocation. It could add a note that no inputs are required, but this is minor.
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 are no parameter semantics for the description to clarify. Per the rubric, 0 params sets a baseline of 4. The description does not need to explain any input, and 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 states a specific verb and resource: the agent will 'receive the list of Google locations supported in App Data API.' That is unambiguous and the 'Google locations' scope implicitly separates it from the sibling get_dataforseo_app_apple_locations. It stops short of naming any sibling or use case, so a 5 is not warranted.
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 numerous sibling endpoints (languages, categories, apple_locations, etc.). The description only restates what calling it returns, which is closer to a restatement than to usage guidance. No exclusions or prerequisites are provided.
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_app_apple_app_info_submitSetting Apple App Info TasksCDestructiveInspect
This endpoint will provide you with information about the App Store application specified in the app_id field of the POST request.
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 |
|---|---|---|---|
| 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 pricing block adds genuine context beyond the annotations (usage-based billing, ~$0.012 estimate). However, the description omits the core behavioral trait: this is an asynchronous task submission whose output must be fetched separately, and it does not surface the cost-bearing priority option or pingback/postback delivery paths documented only in the schema. The "provide you with information" framing also understates the write/create operation implied by readOnlyHint=false 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 prose is short, but it opens with stray zero-width whitespace and devotes roughly half its text to a boilerplate pricing comment block. It is efficient in volume yet the substantive purpose sentence is thin and the billing note dominates relative to operational guidance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, but for a tool with a nested body object requiring app_id plus a language and a location (code or name), the description should at least state that it queues a task and that results come from the fetch sibling. Neither the async flow nor the required nested fields are covered, leaving real gaps for a task-submission 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?
Top-level schema description coverage is reported as 0% because the single "body" parameter carries no description string, so the description should compensate. It only references app_id, which the nested schema already documents in depth along with tag, priority, language/location code-or-name pairs, and postback fields, so the description adds essentially nothing on 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 names a resource (the App Store application identified by app_id) and a soft verb ("provide you with information"), but it never says this is a task-submission endpoint. The name and title say "submit"/"Setting ... Tasks" while the body reads like a synchronous read, leaving an agent uncertain whether it creates an async job or returns data directly.
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 mention of the obvious alternative, get_dataforseo_app_apple_app_info_fetch, which is presumably how the queued task's results are later retrieved. The agent is left to infer the submit-then-fetch workflow from the sibling list alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_app_apple_app_listings_search_liveLive Apple App Listings Search ResultsCDestructiveInspect
This endpoint will provide you with a list of apps published on App Store along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request.
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 |
|---|---|---|---|
| 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 as one that 'will provide you with a list of apps' — a pure retrieval — while the annotations declare destructiveHint=true, readOnlyHint=false, and idempotentHint=false. That is a direct conflict, and the description adds no other behavioral context (no auth, rate limits, or side-effect disclosure) to reconcile it.
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, the parameter note follows, and the pricing block is compact boilerplate that gives the agent useful cost context. The only minor waste is the trailing enumeration of return fields.
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 plus the rich nested schema cover most mechanics. Still, for a search endpoint with no top-level schema description and no usage guidance, the definition leaves the agent without routing or pagination context that would make it 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?
Context reports 0% schema description coverage at the top level (the single 'body' parameter is undocumented in the schema), so the description carries some burden. It names title, description, and categories as the parameters that drive the search, which adds real meaning, but it says nothing about limit, offset, filters, order_by, or offset_token.
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 apps published on the App Store plus metadata (ID, icon, reviews count, rating, price). That is clear enough for an agent to know what it does, but it never distinguishes itself from near-identical siblings such as post_dataforseo_app_google_app_listings_search_live or the app_searches endpoints.
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 contains no when-to-use guidance, no prerequisites, and no named alternatives. It only notes that results depend on title/description/categories, which is a parameter fact rather than a usage rule, so an agent must infer when this endpoint is preferable to its siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_app_apple_app_list_submitSetting Apple App List TasksCDestructiveInspect
This endpoint will provide you with a list of mobile applications published in the top app charts on the App Store platform. The returned results are specific to the app collection as well as the language and location parameters. for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_list/task_post/?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 |
|---|---|---|---|
| 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 partly covered. The description adds genuinely useful non-schema context: usage-based billing (~$0.012 estimate) and that results are scoped to app collection, language, and location. However, it omits the async task lifecycle, how results are delivered (fetch/pingback/postback), and permission or account requirements.
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 content is front-loaded with the result description and kept short, with the doc link and pricing note clearly separated. No filler sentences, though the opening sentence spends its length describing output rather than the submit action.
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 and the nested body properties are richly documented in the schema, so return-value detail is not needed. Still, for a POST task-submission endpoint the description should explain the submit/fetch lifecycle and the key required-parameter dependency; the doc link partly offsets this 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?
The description names app collection, language, and location as the parameters that determine results, which adds a useful semantic cue. But the top-level 'body' parameter has no description and the description does not explain formats or the required-field dependency (language_code or language_name), so it only partially compensates for the reported 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 identifies the resource well ('mobile applications published in the top app charts on the App Store platform') but describes the eventual result rather than the action of the tool, which is to submit an async task. It does not mention that it creates a task whose results must be retrieved via a sibling fetch endpoint, leaving the core purpose partly ambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of prerequisites, and no reference to the natural alternative (get_dataforseo_app_apple_app_list_fetch) that must follow this submission. The agent is left to infer the submit-then-fetch workflow entirely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_app_apple_app_reviews_submitSetting Apple App Reviews TasksCDestructiveInspect
This endpoint will provide you with reviews published on the App Store platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters.
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 |
|---|---|---|---|
| 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, openWorldHint=true, so the safety profile is covered. The description adds only a billing estimate; it omits the key behavioral trait of a submit endpoint (asynchronous task creation, task/id handling, postback delivery), and its 'provide you with reviews' framing reads like a synchronous read, which sits awkwardly against the write-oriented 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?
Short and front-loaded, and the pricing note earns its place, but the leading zero-width characters are noise and the whole second paragraph focuses on output content rather than the action being invoked.
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 billing-affecting, async, open-world task-submission endpoint with a disabled mutation profile, the description should explain task creation and result retrieval (fetch sibling or postback). With an output schema present, return-value detail is excusable, but the async workflow gap is not.
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 underlying schema carries detailed per-field descriptions (depth, sort_by, pingback_url, postback_url, language_code/name, location_code/name), so the metric's 0% coverage understates what is available. The description only name-drops app_id and language/location, adding no meaning beyond the schema; 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 names a specific resource (App Store reviews for the app in app_id) but describes it as if the tool returns reviews directly, when the name/title indicate it submits an async review task. It also fails to differentiate itself from the sibling get_dataforseo_app_apple_app_reviews_fetch, which is the tool that actually delivers results.
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 mention that this creates a task later retrieved via the corresponding fetch tool, and no alternatives named despite a near-identical sibling (post_dataforseo_app_google_app_reviews_submit, get_..._apple_app_reviews_fetch). The agent must infer the submit-vs-fetch workflow 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_app_apple_app_searches_submitSetting Apple App Searches TasksCDestructiveInspect
This endpoint will provide you with a list of apps ranking on the App Store for the specified keyword. The returned results are specific to the indicated keyword, as well as the location and language parameters.
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 |
|---|---|---|---|
| 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 flag this as a non-idempotent, destructive, open-world write. The description adds a genuinely useful billing disclosure ('Usage-based billing; default request estimate: $0.012 USD'), which is real added context. However it omits the single most important behavioral trait — that this is an asynchronous task submission whose results must be picked up later or via pingback/postback — leaving the reader with a misleading synchronous mental model.
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 paragraphs, front-loaded with the outcome and followed by the pricing banner; nothing is padded. The leading zero-width characters are a small cosmetic blemish, but the content itself is tight.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value detail is rightly omitted, and the rich nested body schema covers inputs. What is missing is the operating contract: that this creates a queued task, that billing is per SERP of up to 100 results, and how results are retrieved. For a paid, non-idempotent submission endpoint, that is a substantive 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?
The description names the three key selecting inputs (keyword, location, language), which maps onto the important body fields, but adds no format, encoding, or default detail beyond that. The nested body schema itself carries extensive per-field documentation (depth limits, keyword encoding rules, pingback variables), so the description is not the primary source of 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 a concrete resource and output ('list of apps ranking on the App Store for the specified keyword'), which is specific, but it describes what the *result* contains rather than what the tool *does*. For a `_submit` endpoint the action is creating a task, and a reader could reasonably expect results to be returned inline, which is not what a submit call does.
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 mention of the obvious alternative: the sibling `get_dataforseo_app_apple_app_searches_fetch`, which is what you call to retrieve submitted task results. The description implies a synchronous fetch, so it actively pushes the agent toward the wrong call pattern rather than clarifying the choice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_app_google_app_info_submitSetting Google App Info TasksCDestructiveInspect
This endpoint will provide you with information about the Google Play application specified in the app_id field of the POST request.
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 |
|---|---|---|---|
| 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 write/destructive profile (readOnlyHint=false, destructiveHint=true, idempotentHint=false, openWorldHint=true), so the safety burden is partly covered. The description adds only the billing estimate and does not disclose the key behavioral trait here: that this queues a task whose output must later be pulled via the fetch endpoint. It does not contradict the annotations, but adds little beyond them.
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 short and front-loaded, but it is preceded by stray zero-width characters and followed by an embedded HTML-comment pricing block that reads as noise. Some content earns its place, but the structure is marred by artifacts.
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?
This is a complex async task-submission tool with a rich nested schema, and while an output schema exists (so return values need not be explained), the description should still convey the submit-then-fetch flow, billing implications, and postback/pingback usage. It conveys almost none of that, leaving the agent with an incomplete mental model.
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 body parameter has no top-level description (0% coverage), but its nested fields (app_id, language_code/location_code alternatives, priority, postback/pingback URLs) are documented exhaustively in the schema. The description echoes only app_id and adds no format or constraint detail beyond it, so it neither compensates for nor meaningfully enriches 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 tells the agent the endpoint returns information about a Google Play application identified by app_id. However, it never distinguishes this submit endpoint from its obvious sibling get_dataforseo_app_google_app_info_fetch, nor does it signal that this is the task-creation half of an async submit/fetch pair. Clear purpose, but no sibling differentiation.
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 about when to use this tool versus the numerous sibling fetch/list live endpoints, and no mention that results are retrieved separately after submission. The agent is left to infer the async workflow entirely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_app_google_app_listings_search_liveLive Google App Listings Search ResultsCDestructiveInspect
This endpoint will provide you with a list of apps published on Google Play along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request.
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 |
|---|---|---|---|
| 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 tool as a retrieval ('provide you with a list of apps'), while the annotations declare readOnlyHint=false and destructiveHint=true. A search/list operation is inherently read-only and non-destructive, so the description directly conflicts with the structured safety signals; the only side effect it discloses is billing, which does not explain a destructive hint.
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: the first sentence states the resource and returned fields, the second states the scoping inputs. The trailing pricing comment is boilerplate but brief, so the whole definition is appropriately sized with no wasted 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, and the description does sketch the returned fields. However, for a filter/order_by-heavy endpoint with no top-level parameter descriptions and a contested annotation profile, the description omits cost-per-call behavior, pagination via offset_token, and any guidance on choosing this over sibling search tools.
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% and the single body parameter carries no description of its own, but the nested items (title, limit, offset, filters, order_by, categories) are heavily documented in the schema. The description only echoes the title/description/categories idea already present in the schema and adds no format, default or limit details beyond it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: it returns a list of apps published on Google Play, enriched with ID, icon, review count, rating and price. This is far more than a restatement of the name, but it never distinguishes itself from the many sibling search/list endpoints (Apple listings search live, Google app_list_fetch, app_searches_fetch), so an agent must infer which is the right one.
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 only usage hint is that results are shaped by the title, description and categories parameters. There is no when-to-use / when-not-to-use statement and no mention of alternatives such as the Apple counterpart or the non-live submit endpoints, so routing decisions are left 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_app_google_app_list_submitSetting Google App List TasksCDestructiveInspect
This endpoint will provide you with a list of mobile applications published in the top charts on the Google Play platform. The returned results are specific to the app collection as well as the the language and location parameters.
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 |
|---|---|---|---|
| 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 a write (readOnlyHint=false, destructiveHint=true, non-idempotent), yet the description never discloses the submit/poll lifecycle, the returned task identifier, or that results arrive later via the fetch sibling. It does add a billing estimate, which is useful, but the core async behavior for a non-read-only endpoint is absent.
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 prose is two sentences and front-loaded, which is efficient, but the embedded pricing boilerplate adds template noise and stray zero-width/invisible characters precede the text. Nothing is egregiously bloated, but the wording does not earn its length by conveying the submit action.
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 fields need not be explained, but for an asynchronous, non-idempotent, billed task-submission tool the description omits the one thing an agent most needs: that it registers a task and results must be retrieved separately. Given the nested body schema with 0% coverage, the description is under-specified.
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% (all parameters are nested inside a single 'body' array), so the description must compensate and largely does not. It gestures at app collection/language/location but omits the required-field pairing rules (language_code vs language_name, location_code vs location_name), the mandatory app_collection value set, and the per-100-result depth billing.
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 ('list of mobile applications... top charts on Google Play') but never states the verb that the name promises: this is a task-submission endpoint, yet the prose reads like a retrieval call ('will provide you with a list'). An agent cannot tell from the text that it queues an asynchronous task rather than returning apps, nor how it differs from the sibling get_dataforseo_app_google_app_list_fetch.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no prerequisites, and no mention of the paired fetch tool that must be called to actually obtain results. The only conditional hint ('specific to the app collection as well as the language and location parameters') is echoed from the schema and does not route the agent between alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_app_google_app_reviews_submitSetting Google App Reviews TasksBDestructiveInspect
This endpoint will provide you with reviews published on the Google Play platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters.
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 |
|---|---|---|---|
| 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 destructiveHint=true, readOnlyHint=false and non-idempotent, so the safety profile is covered. The description adds useful billing context (usage-based, $0.012 estimate) that annotations do not, but it omits the central behavioral trait of a submit endpoint: that it returns a task ID asynchronously and results arrive via postback_url or a later fetch.
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 compact pricing block, with the core purpose front-loaded and no padding. The only weakness is that the opening claim about receiving reviews mischaracterizes the submit flow rather than being wasteful.
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?
The output schema is present, so return values need not be restated, and the exhaustive nested schema documents every field. Combined with the billing note and language/location scoping, the definition supplies enough for an agent to call it, the main gaps being usage routing rather than missing mechanics.
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 single body array has no description), so the description must carry param meaning. It only surfaces app_id and the language/location dimensions while leaving depth, rating, sort_by, priority, pingback_url, postback_url, and postback_data unmentioned, though the nested schema does document them thoroughly.
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 resource (Google Play reviews) and the key selector (app_id), but frames a task-submission endpoint as one that 'will provide you with reviews,' which blurs the async submit vs. the sibling fetch (get_dataforseo_app_google_app_reviews_fetch). It never distinguishes itself from that live/fetch alternative, so the actual purpose (queue a task) is only implied.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this submit endpoint versus the fetch sibling, nor any mention of prerequisites, task polling, or the postback/pingback delivery path. The agent gets no routing guidance despite a crowded set of reviews-related siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
post_dataforseo_app_google_app_searches_submitSetting Google App Searches TasksCDestructiveInspect
This endpoint will provide you with a list of apps ranking on Google Play for the specified keyword. The returned results are specific to the indicated keyword, as well as the language and location parameters.
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 |
|---|---|---|---|
| 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 carried by structured data. The description adds pricing context (default $0.012 USD, usage-based, not fixed), which is genuinely useful beyond the annotations. However it omits the key behavioral trait of a submit endpoint: it creates a billable task and returns task IDs rather than the app list itself.
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-loaded, which is good, but it opens with stray zero-width characters and is split by an injected aisa-pricing HTML comment block. The actual functional sentence is one line; the rest is boilerplate.
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 submit/async task endpoint with a rich nested schema, the description is incomplete: it never says the call queues a task, that the response contains task identifiers, or how to fetch the finished results via the sibling. An agent could easily misuse it as a synchronous search.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The top-level 'body' parameter has no description (0% coverage), but the nested task properties (keyword, depth, location_code/name, language_code/name, priority, pingback/postback) are documented in exhaustive detail inside the schema. The description only gestures at 'keyword, language and location parameters', adding little, so it neither compensates for the top-level gap nor detracts.
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 (apps ranking on Google Play for a keyword), so the subject matter is clear. But it describes the eventual *result* rather than the actual action of the tool, which is submitting/queueing an asynchronous task (per the title 'Setting Google App Searches Tasks' and the 'submit' name). It does not distinguish itself from the sibling get_dataforseo_app_google_app_searches_fetch that actually retrieves results, so the verb is misleading.
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 submit endpoint versus the sibling fetch endpoint, nor any mention that results are retrieved later. Given the large sibling set (fetch/live variants), this is a clear gap. Usage is only implied by the description text.
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_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.
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.
20 tool updates
- Added
account - Removed
get_details - Changed
post_dataforseo_app_apple_app_info_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "app_id": "835599320", - "language_code": "en", - "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 `https://apps.apple.com/us/app/id<strong>835599320</strong>`<br>the id is `835599320`", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 `https://api.dataforseo.com/v3/app_data/apple/languages`<em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/pingscript?id=$id`<br>`http://your-server.com/pingscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/postbackscript?id=$id`<br>`http://your-server.com/postbackscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "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 `https://apps.apple.com/us/app/id<strong>835599320</strong>`<br>the id is `835599320`", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 `https://api.dataforseo.com/v3/app_data/apple/languages`<em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/pingscript?id=$id`<br>`http://your-server.com/pingscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/postbackscript?id=$id`<br>`http://your-server.com/postbackscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_apple_app_list_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "app_category": "games", - "app_collection": "top_free_ios", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "app_category": { - "description": "application category on the App Storeoptional fieldyou can filter the results by app category;example:lifestyle;you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", - "type": [ - "string", - "null" - ] - }, - "app_collection": { - "description": "app collectionrequired fieldapp collection on App Store from which apps will be collected;you can specify the following values:top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", - "type": "string" - }, - "depth": { - "description": "parsing depthoptional fieldnumber of apps to be returned from the App Store SERP;default value: 100maximum value: 100Your account will be billed per each SERP containing up to 100 results; The cost can be calculated on the Pricing page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "\"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:en", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:English", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:9061121", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:West Los Angeles,California,United States", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced", - "type": [ - "string", - "null" - ] - }, - "postback_url": { - "description": "URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "app_category": { + "description": "application category on the App Storeoptional fieldyou can filter the results by app category;example:lifestyle;you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", + "type": [ + "string", + "null" + ] + }, + "app_collection": { + "description": "app collectionrequired fieldapp collection on App Store from which apps will be collected;you can specify the following values:top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", + "type": "string" + }, + "depth": { + "description": "parsing depthoptional fieldnumber of apps to be returned from the App Store SERP;default value: 100maximum value: 100Your account will be billed per each SERP containing up to 100 results; The cost can be calculated on the Pricing page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "\"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:en", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:English", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:9061121", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:West Los Angeles,California,United States", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced", + "type": [ + "string", + "null" + ] + }, + "postback_url": { + "description": "URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_apple_app_listings_search_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": { + "categories": { + "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/apple/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "description": { + "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + }, + "filters": { + "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters</code>n", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "additionalProperties": { + "$ref": "#/$defs/Provider0A3E90081762_AisaDataforseoFilterJsonValue" + }, + "type": [ + "object", + "null" + ] + }, + { + "items": { + "$ref": "#/$defs/Provider0A3E90081762_AisaDataforseoFilterJsonValue" + }, + "type": "array" + } + ], + "description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator." + }, + "type": [ + "array", + "null" + ] + }, + "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" + ] + }, + "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", + "type": [ + "integer", + "null" + ] + }, + "offset_token": { + "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "order_by": { + "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.rating.value,desc\"]</code><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>[\"item.rating.value,desc\",\"item.rating.value,desc\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + }, + "title": { + "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "categories": [ - "Utilities" - ], - "description": "vpn", - "filters": [ - [ - "item.rating.value", - ">", - 4.5 - ] - ], - "limit": 10, - "order_by": [ - "item.rating.value,desc" - ], - "title": "vpn" - } - ], - "properties": { - "categories": { - "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/apple/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "description": { - "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - }, - "filters": { - "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters</code>n", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "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" - ] - }, - "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", - "type": [ - "integer", - "null" - ] - }, - "offset_token": { - "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "order_by": { - "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.rating.value,desc\"]</code><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>[\"item.rating.value,desc\",\"item.rating.value,desc\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - }, - "title": { - "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_app_apple_app_reviews_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "app_id": "835599320", - "depth": 200, - "language_code": "en", - "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/id<strong>835599320</strong></code><br>the id is <code>835599320</code>", - "type": "string" - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;<br>default value: <code>25</code>;<br>maximum value: <code>500</code>;<p><strong>Your account will be billed per each SERP containing up to 25 results;</strong> <br>Setting depth above 25 may result in additional charges if the search engine returns more than 25 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br>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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "sort_by": { - "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code> — sort by the most recent reviews;<br><code>most_helpful</code> — sort by the most relevant reviews;<br>default rule: <code>most_helpful</code>", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "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/id<strong>835599320</strong></code><br>the id is <code>835599320</code>", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;<br>default value: <code>25</code>;<br>maximum value: <code>500</code>;<p><strong>Your account will be billed per each SERP containing up to 25 results;</strong> <br>Setting depth above 25 may result in additional charges if the search engine returns more than 25 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br>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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "sort_by": { + "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code> — sort by the most recent reviews;<br><code>most_helpful</code> — sort by the most relevant reviews;<br>default rule: <code>most_helpful</code>", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_apple_app_searches_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "depth": 200, - "keyword": "vpn", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned from the App Store SERP;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code><br>maximum value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned from the App Store SERP;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code><br>maximum value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_google_app_info_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "language_code": "en", - "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=<strong>org.telegram.messenger</strong></code><br>the id is <code>org.telegram.messenger</code>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "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=<strong>org.telegram.messenger</strong></code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_google_app_list_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "app_collection": "topselling_free", - "depth": 100, - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "age_rating": { - "description": "<em>filter results by age rating</em><br>optional field<br>you can use this field to filter the results by age rating;<br>possible types of filtering:<br><code>ages_up_to_5</code> — return apps approved for children up to 5 years old;<br><code>ages_6_8</code> — return apps approved for children from 6 to 8 years old;<br><code>ages_9_12</code> — return apps approved for children from 9 to 12 years old;<br>by default, the API returns apps for all ages;<br><strong>Note:</strong> this filter works only in conjunction with the <code>\"category\": \"family\"</code> parameter", - "type": [ - "string", - "null" - ] - }, - "app_category": { - "description": "<em>application category on Google Play</em><br>optional field<br>you can filter the results by app category;<br>example:<br><code>family</code>;<br>you can receive the full list of available categories by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/categories</code><br><strong>Note:</strong> <code>app_category</code> cannot be used if <code>app_collection</code> parameter is set to <code>featured</code>", - "type": [ - "string", - "null" - ] - }, - "app_collection": { - "description": "<em>app collection</em><br><strong>required field</strong><br>app collection on Google Play from which apps will be collected;<br>you can specify the following values:<br><code>featured</code>, <code>topselling_paid</code>, <code>topselling_free</code>, <code>topselling_new_free</code>, <code>topselling_new_paid</code>, <code>topgrossing</code>, <code>movers_shakers</code><br><strong>Note:</strong> if <code>featured</code> is selected, the <code>app_category</code> parameter cannot be used", - "type": "string" - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of apps to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "age_rating": { + "description": "<em>filter results by age rating</em><br>optional field<br>you can use this field to filter the results by age rating;<br>possible types of filtering:<br><code>ages_up_to_5</code> — return apps approved for children up to 5 years old;<br><code>ages_6_8</code> — return apps approved for children from 6 to 8 years old;<br><code>ages_9_12</code> — return apps approved for children from 9 to 12 years old;<br>by default, the API returns apps for all ages;<br><strong>Note:</strong> this filter works only in conjunction with the <code>\"category\": \"family\"</code> parameter", + "type": [ + "string", + "null" + ] + }, + "app_category": { + "description": "<em>application category on Google Play</em><br>optional field<br>you can filter the results by app category;<br>example:<br><code>family</code>;<br>you can receive the full list of available categories by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/categories</code><br><strong>Note:</strong> <code>app_category</code> cannot be used if <code>app_collection</code> parameter is set to <code>featured</code>", + "type": [ + "string", + "null" + ] + }, + "app_collection": { + "description": "<em>app collection</em><br><strong>required field</strong><br>app collection on Google Play from which apps will be collected;<br>you can specify the following values:<br><code>featured</code>, <code>topselling_paid</code>, <code>topselling_free</code>, <code>topselling_new_free</code>, <code>topselling_new_paid</code>, <code>topgrossing</code>, <code>movers_shakers</code><br><strong>Note:</strong> if <code>featured</code> is selected, the <code>app_category</code> parameter cannot be used", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of apps to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_google_app_listings_search_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": { + "categories": { + "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/google/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "description": { + "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + }, + "filters": { + "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><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>[\"item.rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters</code>", + "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" + ] + }, + "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" + ] + }, + "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", + "type": [ + "integer", + "null" + ] + }, + "offset_token": { + "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "order_by": { + "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.installs_count,asc\"]</code><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>[\"item.rating.value,desc\",\"item.installs_count,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" + ] + }, + "title": { + "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / oneOfRemoved value: -[ - { - "example": [ - { - "categories": [ - "Tools" - ], - "description": "vpn", - "filters": [ - [ - "item.rating.value", - ">", - 4.5 - ] - ], - "limit": 10, - "order_by": [ - "item.installs_count,asc" - ], - "title": "vpn" - } - ], - "properties": { - "categories": { - "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/google/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "description": { - "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - }, - "filters": { - "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><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>[\"item.rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters</code>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "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" - ] - }, - "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", - "type": [ - "integer", - "null" - ] - }, - "offset_token": { - "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "order_by": { - "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.installs_count,asc\"]</code><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>[\"item.rating.value,desc\",\"item.installs_count,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" - ] - }, - "title": { - "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]
- Changed
post_dataforseo_app_google_app_reviews_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "depth": 150, - "language_code": "en", - "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><code>https://play.google.com/store/apps/details?id=<strong>org.telegram.messenger</strong></code>", - "type": "string" - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;<br>default value: <code>150</code>;<br>maximum value: <code>100000</code>;<br><strong>Your account will be billed per each SERP containing up to 150 results;</strong> <br>Setting depth above 150 may result in additional charges if the search engine returns more than 150 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "rating": { - "description": "<em>filter reviews by rating</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>5</code> — return reviews with five-star rating only;<br><code>4</code> — return reviews with four-star rating only;<br><code>3</code> — return reviews with three-star rating only;<br><code>2</code> — return reviews with two-star rating only;<br><code>1</code> — return reviews with one-star rating only;<br>by default, the API returns all reviews regardless of the number of stars", - "type": [ - "integer", - "null" - ] - }, - "sort_by": { - "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>newest</code> — sort by the most recent reviews;<br><code>most_relevant</code> — sort by the most relevant reviews;<br>default rule: <code>most_relevant</code>", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "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><code>https://play.google.com/store/apps/details?id=<strong>org.telegram.messenger</strong></code>", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;<br>default value: <code>150</code>;<br>maximum value: <code>100000</code>;<br><strong>Your account will be billed per each SERP containing up to 150 results;</strong> <br>Setting depth above 150 may result in additional charges if the search engine returns more than 150 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "rating": { + "description": "<em>filter reviews by rating</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>5</code> — return reviews with five-star rating only;<br><code>4</code> — return reviews with four-star rating only;<br><code>3</code> — return reviews with three-star rating only;<br><code>2</code> — return reviews with two-star rating only;<br><code>1</code> — return reviews with one-star rating only;<br>by default, the API returns all reviews regardless of the number of stars", + "type": [ + "integer", + "null" + ] + }, + "sort_by": { + "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>newest</code> — sort by the most recent reviews;<br><code>most_relevant</code> — sort by the most relevant reviews;<br>default rule: <code>most_relevant</code>", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_google_app_searches_submit1 field changed- changed
Input schema / properties / body / items / oneOfPrevious value: -[ - { - "example": [ - { - "depth": 30, - "keyword": "vpn", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned to be returned from the Google Play SERP;<br>we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned to be returned from the Google Play SERP;<br>we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- 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_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" - } -]
18 tool updates
- Changed
post_dataforseo_app_apple_app_info_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "835599320", - "language_code": "en", - "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 `https://apps.apple.com/us/app/id<strong>835599320</strong>`<br>the id is `835599320`", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 `https://api.dataforseo.com/v3/app_data/apple/languages`<em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/pingscript?id=$id`<br>`http://your-server.com/pingscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/postbackscript?id=$id`<br>`http://your-server.com/postbackscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_id": "835599320", + "language_code": "en", + "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 `https://apps.apple.com/us/app/id<strong>835599320</strong>`<br>the id is `835599320`", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 `https://api.dataforseo.com/v3/app_data/apple/languages`<em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/pingscript?id=$id`<br>`http://your-server.com/pingscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/postbackscript?id=$id`<br>`http://your-server.com/postbackscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_apple_app_list_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_category": "games", - "app_collection": "top_free_ios", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "app_category": { - "description": "application category on the App Storeoptional fieldyou can filter the results by app category;example:lifestyle;you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", - "type": [ - "string", - "null" - ] - }, - "app_collection": { - "description": "app collectionrequired fieldapp collection on App Store from which apps will be collected;you can specify the following values:top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", - "type": "string" - }, - "depth": { - "description": "parsing depthoptional fieldnumber of apps to be returned from the App Store SERP;default value: 100maximum value: 100Your account will be billed per each SERP containing up to 100 results; The cost can be calculated on the Pricing page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "\"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:en", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:English", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:9061121", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:West Los Angeles,California,United States", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced", - "type": [ - "string", - "null" - ] - }, - "postback_url": { - "description": "URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_category": "games", + "app_collection": "top_free_ios", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "app_category": { + "description": "application category on the App Storeoptional fieldyou can filter the results by app category;example:lifestyle;you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", + "type": [ + "string", + "null" + ] + }, + "app_collection": { + "description": "app collectionrequired fieldapp collection on App Store from which apps will be collected;you can specify the following values:top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", + "type": "string" + }, + "depth": { + "description": "parsing depthoptional fieldnumber of apps to be returned from the App Store SERP;default value: 100maximum value: 100Your account will be billed per each SERP containing up to 100 results; The cost can be calculated on the Pricing page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "\"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:en", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:English", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:9061121", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:West Los Angeles,California,United States", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced", + "type": [ + "string", + "null" + ] + }, + "postback_url": { + "description": "URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_apple_app_listings_search_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "categories": [ - "Utilities" - ], - "description": "vpn", - "filters": [ - [ - "item.rating.value", - ">", - 4.5 - ] - ], - "limit": 10, - "order_by": [ - "item.rating.value,desc" - ], - "title": "vpn" - } - ], - "properties": { - "categories": { - "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/apple/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "description": { - "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - }, - "filters": { - "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters</code>n", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "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" - ] - }, - "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", - "type": [ - "integer", - "null" - ] - }, - "offset_token": { - "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "order_by": { - "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.rating.value,desc\"]</code><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>[\"item.rating.value,desc\",\"item.rating.value,desc\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - }, - "title": { - "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "categories": [ + "Utilities" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.rating.value,desc" + ], + "title": "vpn" + } + ], + "properties": { + "categories": { + "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/apple/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "description": { + "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + }, + "filters": { + "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters</code>n", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "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" + ] + }, + "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", + "type": [ + "integer", + "null" + ] + }, + "offset_token": { + "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "order_by": { + "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.rating.value,desc\"]</code><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>[\"item.rating.value,desc\",\"item.rating.value,desc\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + }, + "title": { + "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_apple_app_reviews_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "835599320", - "depth": 200, - "language_code": "en", - "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/id<strong>835599320</strong></code><br>the id is <code>835599320</code>", - "type": "string" - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;<br>default value: <code>25</code>;<br>maximum value: <code>500</code>;<p><strong>Your account will be billed per each SERP containing up to 25 results;</strong> <br>Setting depth above 25 may result in additional charges if the search engine returns more than 25 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br>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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "sort_by": { - "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code> — sort by the most recent reviews;<br><code>most_helpful</code> — sort by the most relevant reviews;<br>default rule: <code>most_helpful</code>", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_id": "835599320", + "depth": 200, + "language_code": "en", + "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/id<strong>835599320</strong></code><br>the id is <code>835599320</code>", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;<br>default value: <code>25</code>;<br>maximum value: <code>500</code>;<p><strong>Your account will be billed per each SERP containing up to 25 results;</strong> <br>Setting depth above 25 may result in additional charges if the search engine returns more than 25 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br>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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "sort_by": { + "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code> — sort by the most recent reviews;<br><code>most_helpful</code> — sort by the most relevant reviews;<br>default rule: <code>most_helpful</code>", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_apple_app_searches_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "depth": 200, - "keyword": "vpn", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned from the App Store SERP;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code><br>maximum value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "depth": 200, + "keyword": "vpn", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned from the App Store SERP;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code><br>maximum value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_google_app_info_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "language_code": "en", - "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=<strong>org.telegram.messenger</strong></code><br>the id is <code>org.telegram.messenger</code>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "language_code": "en", + "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=<strong>org.telegram.messenger</strong></code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_google_app_list_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_collection": "topselling_free", - "depth": 100, - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "age_rating": { - "description": "<em>filter results by age rating</em><br>optional field<br>you can use this field to filter the results by age rating;<br>possible types of filtering:<br><code>ages_up_to_5</code> — return apps approved for children up to 5 years old;<br><code>ages_6_8</code> — return apps approved for children from 6 to 8 years old;<br><code>ages_9_12</code> — return apps approved for children from 9 to 12 years old;<br>by default, the API returns apps for all ages;<br><strong>Note:</strong> this filter works only in conjunction with the <code>\"category\": \"family\"</code> parameter", - "type": [ - "string", - "null" - ] - }, - "app_category": { - "description": "<em>application category on Google Play</em><br>optional field<br>you can filter the results by app category;<br>example:<br><code>family</code>;<br>you can receive the full list of available categories by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/categories</code><br><strong>Note:</strong> <code>app_category</code> cannot be used if <code>app_collection</code> parameter is set to <code>featured</code>", - "type": [ - "string", - "null" - ] - }, - "app_collection": { - "description": "<em>app collection</em><br><strong>required field</strong><br>app collection on Google Play from which apps will be collected;<br>you can specify the following values:<br><code>featured</code>, <code>topselling_paid</code>, <code>topselling_free</code>, <code>topselling_new_free</code>, <code>topselling_new_paid</code>, <code>topgrossing</code>, <code>movers_shakers</code><br><strong>Note:</strong> if <code>featured</code> is selected, the <code>app_category</code> parameter cannot be used", - "type": "string" - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of apps to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_collection": "topselling_free", + "depth": 100, + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "age_rating": { + "description": "<em>filter results by age rating</em><br>optional field<br>you can use this field to filter the results by age rating;<br>possible types of filtering:<br><code>ages_up_to_5</code> — return apps approved for children up to 5 years old;<br><code>ages_6_8</code> — return apps approved for children from 6 to 8 years old;<br><code>ages_9_12</code> — return apps approved for children from 9 to 12 years old;<br>by default, the API returns apps for all ages;<br><strong>Note:</strong> this filter works only in conjunction with the <code>\"category\": \"family\"</code> parameter", + "type": [ + "string", + "null" + ] + }, + "app_category": { + "description": "<em>application category on Google Play</em><br>optional field<br>you can filter the results by app category;<br>example:<br><code>family</code>;<br>you can receive the full list of available categories by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/categories</code><br><strong>Note:</strong> <code>app_category</code> cannot be used if <code>app_collection</code> parameter is set to <code>featured</code>", + "type": [ + "string", + "null" + ] + }, + "app_collection": { + "description": "<em>app collection</em><br><strong>required field</strong><br>app collection on Google Play from which apps will be collected;<br>you can specify the following values:<br><code>featured</code>, <code>topselling_paid</code>, <code>topselling_free</code>, <code>topselling_new_free</code>, <code>topselling_new_paid</code>, <code>topgrossing</code>, <code>movers_shakers</code><br><strong>Note:</strong> if <code>featured</code> is selected, the <code>app_category</code> parameter cannot be used", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of apps to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_google_app_listings_search_live2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "categories": [ - "Tools" - ], - "description": "vpn", - "filters": [ - [ - "item.rating.value", - ">", - 4.5 - ] - ], - "limit": 10, - "order_by": [ - "item.installs_count,asc" - ], - "title": "vpn" - } - ], - "properties": { - "categories": { - "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/google/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "description": { - "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - }, - "filters": { - "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><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>[\"item.rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters</code>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "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" - ] - }, - "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", - "type": [ - "integer", - "null" - ] - }, - "offset_token": { - "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "order_by": { - "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.installs_count,asc\"]</code><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>[\"item.rating.value,desc\",\"item.installs_count,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" - ] - }, - "title": { - "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "categories": [ + "Tools" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.installs_count,asc" + ], + "title": "vpn" + } + ], + "properties": { + "categories": { + "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/google/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "description": { + "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + }, + "filters": { + "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><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>[\"item.rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters</code>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "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" + ] + }, + "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", + "type": [ + "integer", + "null" + ] + }, + "offset_token": { + "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "order_by": { + "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.installs_count,asc\"]</code><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>[\"item.rating.value,desc\",\"item.installs_count,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" + ] + }, + "title": { + "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_google_app_reviews_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "depth": 150, - "language_code": "en", - "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><code>https://play.google.com/store/apps/details?id=<strong>org.telegram.messenger</strong></code>", - "type": "string" - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;<br>default value: <code>150</code>;<br>maximum value: <code>100000</code>;<br><strong>Your account will be billed per each SERP containing up to 150 results;</strong> <br>Setting depth above 150 may result in additional charges if the search engine returns more than 150 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "rating": { - "description": "<em>filter reviews by rating</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>5</code> — return reviews with five-star rating only;<br><code>4</code> — return reviews with four-star rating only;<br><code>3</code> — return reviews with three-star rating only;<br><code>2</code> — return reviews with two-star rating only;<br><code>1</code> — return reviews with one-star rating only;<br>by default, the API returns all reviews regardless of the number of stars", - "type": [ - "integer", - "null" - ] - }, - "sort_by": { - "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>newest</code> — sort by the most recent reviews;<br><code>most_relevant</code> — sort by the most relevant reviews;<br>default rule: <code>most_relevant</code>", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "depth": 150, + "language_code": "en", + "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><code>https://play.google.com/store/apps/details?id=<strong>org.telegram.messenger</strong></code>", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;<br>default value: <code>150</code>;<br>maximum value: <code>100000</code>;<br><strong>Your account will be billed per each SERP containing up to 150 results;</strong> <br>Setting depth above 150 may result in additional charges if the search engine returns more than 150 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "rating": { + "description": "<em>filter reviews by rating</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>5</code> — return reviews with five-star rating only;<br><code>4</code> — return reviews with four-star rating only;<br><code>3</code> — return reviews with three-star rating only;<br><code>2</code> — return reviews with two-star rating only;<br><code>1</code> — return reviews with one-star rating only;<br>by default, the API returns all reviews regardless of the number of stars", + "type": [ + "integer", + "null" + ] + }, + "sort_by": { + "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>newest</code> — sort by the most recent reviews;<br><code>most_relevant</code> — sort by the most relevant reviews;<br>default rule: <code>most_relevant</code>", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- Changed
post_dataforseo_app_google_app_searches_submit2 fields changed- removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "depth": 30, - "keyword": "vpn", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned to be returned from the Google Play SERP;<br>we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / oneOfAdded value: +[ + { + "example": [ + { + "depth": 30, + "keyword": "vpn", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned to be returned from the Google Play SERP;<br>we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +]
- 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_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" + } +]
43 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_dataforseo_app_apple_app_info_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_app_list_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_app_listings_categories1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_app_reviews_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_app_searches_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_categories1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_info_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_info_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_list_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_list_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_listings_categories1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_reviews_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_searches_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_searches_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_categories1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_locations1 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
post_dataforseo_app_apple_app_info_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "835599320", + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "835599320", + "language_code": "en", + "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 `https://apps.apple.com/us/app/id<strong>835599320</strong>`<br>the id is `835599320`", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 `https://api.dataforseo.com/v3/app_data/apple/languages`<em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/pingscript?id=$id`<br>`http://your-server.com/pingscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/postbackscript?id=$id`<br>`http://your-server.com/postbackscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - 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" - }, - "language_code": { - "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages` example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_app_apple_app_list_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_category": "games", + "app_collection": "top_free_ios", + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_category": "games", + "app_collection": "top_free_ios", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "app_category": { + "description": "application category on the App Storeoptional fieldyou can filter the results by app category;example:lifestyle;you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", + "type": [ + "string", + "null" + ] + }, + "app_collection": { + "description": "app collectionrequired fieldapp collection on App Store from which apps will be collected;you can specify the following values:top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", + "type": "string" + }, + "depth": { + "description": "parsing depthoptional fieldnumber of apps to be returned from the App Store SERP;default value: 100maximum value: 100Your account will be billed per each SERP containing up to 100 results; The cost can be calculated on the Pricing page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "\"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:en", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:English", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:9061121", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:West Los Angeles,California,United States", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced", + "type": [ + "string", + "null" + ] + }, + "postback_url": { + "description": "URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_category": { - "description": "application category on the App Store optional field you can filter the results by app category; example: lifestyle; you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", - "type": "string" - }, - "app_collection": { - "description": "app collection required field app collection on App Store from which apps will be collected; you can specify the following values: top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", - "type": "string" - }, - "depth": { - "description": "parsing depth optional field number of apps to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 1000 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", - "type": "integer" - }, - "language_code": { - "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_collection" -] - 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_app_apple_app_listings_search_live5 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "categories": [ + "Utilities" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.rating.value,desc" + ], + "title": "vpn" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "categories": [ + "Utilities" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.rating.value,desc" + ], + "title": "vpn" + } + ], + "properties": { + "categories": { + "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/apple/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "description": { + "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + }, + "filters": { + "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters</code>n", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "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" + ] + }, + "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", + "type": [ + "integer", + "null" + ] + }, + "offset_token": { + "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "order_by": { + "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.rating.value,desc\"]</code><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>[\"item.rating.value,desc\",\"item.rating.value,desc\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + }, + "title": { + "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "categories": { - "description": "app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories", - "items": { - "type": "string" - }, - "type": "array" - }, - "description": { - "description": "keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters", - "type": "string" - }, - "filters": { - "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filtersn", - "items": {}, - "type": "array" - }, - "limit": { - "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "offset": { - "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center", - "type": "string" - }, - "order_by": { - "description": "results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: [\"item.rating.value,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"item.rating.value,desc\",\"item.rating.value,desc\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - }, - "title": { - "description": "keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_app_apple_app_reviews_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "835599320", + "depth": 200, + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "835599320", + "depth": 200, + "language_code": "en", + "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/id<strong>835599320</strong></code><br>the id is <code>835599320</code>", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;<br>default value: <code>25</code>;<br>maximum value: <code>500</code>;<p><strong>Your account will be billed per each SERP containing up to 25 results;</strong> <br>Setting depth above 25 may result in additional charges if the search engine returns more than 25 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br>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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "sort_by": { + "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code> — sort by the most recent reviews;<br><code>most_helpful</code> — sort by the most relevant reviews;<br>default rule: <code>most_helpful</code>", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - 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" - }, - "depth": { - "description": "parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row; default value: 25; maximum value: 500; Your account will be billed per each SERP containing up to 25 results; Setting depth above 25 may result in additional charges if the search engine returns more than 25 results.", - "type": "integer" - }, - "language_code": { - "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "sort_by": { - "description": "results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent — sort by the most recent reviews; most_helpful — sort by the most relevant reviews; default rule: most_helpful", - "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_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_app_apple_app_searches_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "depth": 200, + "keyword": "vpn", + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "depth": 200, + "keyword": "vpn", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned from the App Store SERP;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code><br>maximum value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "parsing depth optional field number of results to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", - "type": "integer" - }, - "keyword": { - "description": "keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_app_google_app_info_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "org.telegram.messenger", + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "language_code": "en", + "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=<strong>org.telegram.messenger</strong></code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - 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" - }, - "language_code": { - "description": "search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_app_google_app_list_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_collection": "topselling_free", + "depth": 100, + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_collection": "topselling_free", + "depth": 100, + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "age_rating": { + "description": "<em>filter results by age rating</em><br>optional field<br>you can use this field to filter the results by age rating;<br>possible types of filtering:<br><code>ages_up_to_5</code> — return apps approved for children up to 5 years old;<br><code>ages_6_8</code> — return apps approved for children from 6 to 8 years old;<br><code>ages_9_12</code> — return apps approved for children from 9 to 12 years old;<br>by default, the API returns apps for all ages;<br><strong>Note:</strong> this filter works only in conjunction with the <code>\"category\": \"family\"</code> parameter", + "type": [ + "string", + "null" + ] + }, + "app_category": { + "description": "<em>application category on Google Play</em><br>optional field<br>you can filter the results by app category;<br>example:<br><code>family</code>;<br>you can receive the full list of available categories by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/categories</code><br><strong>Note:</strong> <code>app_category</code> cannot be used if <code>app_collection</code> parameter is set to <code>featured</code>", + "type": [ + "string", + "null" + ] + }, + "app_collection": { + "description": "<em>app collection</em><br><strong>required field</strong><br>app collection on Google Play from which apps will be collected;<br>you can specify the following values:<br><code>featured</code>, <code>topselling_paid</code>, <code>topselling_free</code>, <code>topselling_new_free</code>, <code>topselling_new_paid</code>, <code>topgrossing</code>, <code>movers_shakers</code><br><strong>Note:</strong> if <code>featured</code> is selected, the <code>app_category</code> parameter cannot be used", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of apps to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "age_rating": { - "description": "filter results by age rating optional field you can use this field to filter the results by age rating; possible types of filtering: ages_up_to_5 — return apps approved for children up to 5 years old; ages_6_8 — return apps approved for children from 6 to 8 years old; ages_9_12 — return apps approved for children from 9 to 12 years old; by default, the API returns apps for all ages; Note: this filter works only in conjunction with the \"category\": \"family\" parameter", - "type": "string" - }, - "app_category": { - "description": "application category on Google Play optional field you can filter the results by app category; example: family; you can receive the full list of available categories by making a separate request to https://api.dataforseo.com/v3/app_data/google/categories Note: app_category cannot be used if app_collection parameter is set to featured", - "type": "string" - }, - "app_collection": { - "description": "app collection required field app collection on Google Play from which apps will be collected; you can specify the following values: featured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid, topgrossing, movers_shakers Note: if featured is selected, the app_category parameter cannot be used", - "type": "string" - }, - "depth": { - "description": "parsing depth optional field number of apps to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100; maximum value: 200; Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", - "type": "integer" - }, - "language_code": { - "description": "search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_collection" -] - 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_app_google_app_listings_search_live5 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "categories": [ + "Tools" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.installs_count,asc" + ], + "title": "vpn" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "categories": [ + "Tools" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.installs_count,asc" + ], + "title": "vpn" + } + ], + "properties": { + "categories": { + "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/google/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "description": { + "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + }, + "filters": { + "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><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>[\"item.rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters</code>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "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" + ] + }, + "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", + "type": [ + "integer", + "null" + ] + }, + "offset_token": { + "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "order_by": { + "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.installs_count,asc\"]</code><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>[\"item.rating.value,desc\",\"item.installs_count,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" + ] + }, + "title": { + "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "categories": { - "description": "app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories", - "items": { - "type": "string" - }, - "type": "array" - }, - "description": { - "description": "keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters", - "type": "string" - }, - "filters": { - "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"item.rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters", - "items": {}, - "type": "array" - }, - "limit": { - "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "offset": { - "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center", - "type": "string" - }, - "order_by": { - "description": "results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: [\"item.installs_count,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: [\"item.rating.value,desc\",\"item.installs_count,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" - }, - "title": { - "description": "keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_app_google_app_reviews_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "org.telegram.messenger", + "depth": 150, + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "depth": 150, + "language_code": "en", + "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><code>https://play.google.com/store/apps/details?id=<strong>org.telegram.messenger</strong></code>", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;<br>default value: <code>150</code>;<br>maximum value: <code>100000</code>;<br><strong>Your account will be billed per each SERP containing up to 150 results;</strong> <br>Setting depth above 150 may result in additional charges if the search engine returns more than 150 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "rating": { + "description": "<em>filter reviews by rating</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>5</code> — return reviews with five-star rating only;<br><code>4</code> — return reviews with four-star rating only;<br><code>3</code> — return reviews with three-star rating only;<br><code>2</code> — return reviews with two-star rating only;<br><code>1</code> — return reviews with one-star rating only;<br>by default, the API returns all reviews regardless of the number of stars", + "type": [ + "integer", + "null" + ] + }, + "sort_by": { + "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>newest</code> — sort by the most recent reviews;<br><code>most_relevant</code> — sort by the most relevant reviews;<br>default rule: <code>most_relevant</code>", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - 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: https://play.google.com/store/apps/details?id=org.telegram.messenger", - "type": "string" - }, - "depth": { - "description": "parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row; default value: 150; maximum value: 100000; Your account will be billed per each SERP containing up to 150 results; Setting depth above 150 may result in additional charges if the search engine returns more than 150 results.", - "type": "integer" - }, - "language_code": { - "description": "search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "rating": { - "description": "filter reviews by rating optional field you can use this field to filter the results; possible types of filtering: 5 — return reviews with five-star rating only; 4 — return reviews with four-star rating only; 3 — return reviews with three-star rating only; 2 — return reviews with two-star rating only; 1 — return reviews with one-star rating only; by default, the API returns all reviews regardless of the number of stars", - "type": "integer" - }, - "sort_by": { - "description": "results sorting parameters optional field you can use this field to sort the results; possible types of sorting: newest — sort by the most recent reviews; most_relevant — sort by the most relevant reviews; default rule: most_relevant", - "type": "string" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_app_google_app_searches_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "depth": 30, + "keyword": "vpn", + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "depth": 30, + "keyword": "vpn", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned to be returned from the Google Play SERP;<br>we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "parsing depth optional field number of results to be returned to be returned from the Google Play SERP; we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row; default value: 30; maximum value: 200; Your account will be billed per each SERP containing up to 30 results; Setting depth above 30 may result in additional charges if the search engine returns more than 30 results.", - "type": "integer" - }, - "keyword": { - "description": "keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "search engine 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 https://api.dataforseo.com/v3/app_data/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine 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 language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_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
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"
43 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_dataforseo_app_apple_app_info_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_apple_app_list_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_apple_app_listings_categories1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_apple_app_reviews_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_apple_app_searches_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_apple_categories1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_apple_languages1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_apple_locations1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_app_info_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_app_info_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_app_list_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_app_list_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_app_listings_categories1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_app_reviews_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_app_searches_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_app_searches_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time" - removed
Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_categories1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_languages1 field changed- removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
get_dataforseo_app_google_locations1 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
post_dataforseo_app_apple_app_info_submit8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_id": "835599320", - "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" + ] + } + ] + }, + { + "anyOf": [ + { + "not": { + "required": [ + "postback_url" + ] + } + }, + { + "required": [ + "postback_data" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "835599320", - "language_code": "en", - "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 `https://apps.apple.com/us/app/id<strong>835599320</strong>`<br>the id is `835599320`", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 `https://api.dataforseo.com/v3/app_data/apple/languages`<em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`<br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/pingscript?id=$id`<br>`http://your-server.com/pingscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/postbackscript?id=$id`<br>`http://your-server.com/postbackscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - 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" + }, + "language_code": { + "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages` example: en", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", + "type": "integer" + }, + "location_name": { + "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", + "type": "string" + }, + "pingback_url": { + "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", + "type": "string" + }, + "postback_data": { + "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", + "type": "string" + }, + "postback_url": { + "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", + "type": "string" + }, + "priority": { + "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", + "type": "integer" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + } +} - 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_app_apple_app_list_submit8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_category": "games", - "app_collection": "top_free_ios", - "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" + ] + } + ] + }, + { + "anyOf": [ + { + "not": { + "required": [ + "postback_url" + ] + } + }, + { + "required": [ + "postback_data" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_category": "games", - "app_collection": "top_free_ios", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "app_category": { - "description": "application category on the App Storeoptional fieldyou can filter the results by app category;example:lifestyle;you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", - "type": [ - "string", - "null" - ] - }, - "app_collection": { - "description": "app collectionrequired fieldapp collection on App Store from which apps will be collected;you can specify the following values:top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", - "type": "string" - }, - "depth": { - "description": "parsing depthoptional fieldnumber of apps to be returned from the App Store SERP;default value: 100maximum value: 100Your account will be billed per each SERP containing up to 100 results; The cost can be calculated on the Pricing page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "\"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:en", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:English", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:9061121", - "type": [ - "integer", - "null" - ] - }, - "location_name": { - "description": "full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:West Los Angeles,California,United States", - "type": [ - "string", - "null" - ] - }, - "pingback_url": { - "description": "notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced", - "type": [ - "string", - "null" - ] - }, - "postback_url": { - "description": "URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "app_category": { + "description": "application category on the App Store optional field you can filter the results by app category; example: lifestyle; you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", + "type": "string" + }, + "app_collection": { + "description": "app collection required field app collection on App Store from which apps will be collected; you can specify the following values: top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", + "type": "string" + }, + "depth": { + "description": "parsing depth optional field number of apps to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 1000 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", + "type": "integer" + }, + "language_code": { + "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", + "type": "integer" + }, + "location_name": { + "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", + "type": "string" + }, + "pingback_url": { + "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", + "type": "string" + }, + "postback_data": { + "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", + "type": "string" + }, + "postback_url": { + "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", + "type": "string" + }, + "priority": { + "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", + "type": "integer" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_collection" +] - 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_app_apple_app_listings_search_live5 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "categories": [ - "Utilities" - ], - "description": "vpn", - "filters": [ - [ - "item.rating.value", - ">", - 4.5 - ] - ], - "limit": 10, - "order_by": [ - "item.rating.value,desc" - ], - "title": "vpn" - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "categories": [ - "Utilities" - ], - "description": "vpn", - "filters": [ - [ - "item.rating.value", - ">", - 4.5 - ] - ], - "limit": 10, - "order_by": [ - "item.rating.value,desc" - ], - "title": "vpn" - } - ], - "properties": { - "categories": { - "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/apple/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "description": { - "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - }, - "filters": { - "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters</code>n", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "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" - ] - }, - "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", - "type": [ - "integer", - "null" - ] - }, - "offset_token": { - "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "order_by": { - "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.rating.value,desc\"]</code><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>[\"item.rating.value,desc\",\"item.rating.value,desc\"]</code>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - }, - "title": { - "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "categories": { + "description": "app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters", + "type": "string" + }, + "filters": { + "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filtersn", + "items": {}, + "type": "array" + }, + "limit": { + "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "offset": { + "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", + "type": "integer" + }, + "offset_token": { + "description": "token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center", + "type": "string" + }, + "order_by": { + "description": "results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: [\"item.rating.value,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"item.rating.value,desc\",\"item.rating.value,desc\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + }, + "title": { + "description": "keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters", + "type": "string" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_app_apple_app_reviews_submit8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_id": "835599320", - "depth": 200, - "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" + ] + } + ] + }, + { + "anyOf": [ + { + "not": { + "required": [ + "postback_url" + ] + } + }, + { + "required": [ + "postback_data" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "835599320", - "depth": 200, - "language_code": "en", - "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/id<strong>835599320</strong></code><br>the id is <code>835599320</code>", - "type": "string" - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;<br>default value: <code>25</code>;<br>maximum value: <code>500</code>;<p><strong>Your account will be billed per each SERP containing up to 25 results;</strong> <br>Setting depth above 25 may result in additional charges if the search engine returns more than 25 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br>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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "sort_by": { - "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code> — sort by the most recent reviews;<br><code>most_helpful</code> — sort by the most relevant reviews;<br>default rule: <code>most_helpful</code>", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - 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" + }, + "depth": { + "description": "parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row; default value: 25; maximum value: 500; Your account will be billed per each SERP containing up to 25 results; Setting depth above 25 may result in additional charges if the search engine returns more than 25 results.", + "type": "integer" + }, + "language_code": { + "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", + "type": "integer" + }, + "location_name": { + "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", + "type": "string" + }, + "pingback_url": { + "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", + "type": "string" + }, + "postback_data": { + "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", + "type": "string" + }, + "postback_url": { + "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", + "type": "string" + }, + "priority": { + "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", + "type": "integer" + }, + "sort_by": { + "description": "results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent — sort by the most recent reviews; most_helpful — sort by the most relevant reviews; default rule: most_helpful", + "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_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_app_apple_app_searches_submit8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "depth": 200, - "keyword": "vpn", - "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" + ] + } + ] + }, + { + "anyOf": [ + { + "not": { + "required": [ + "postback_url" + ] + } + }, + { + "required": [ + "postback_data" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "depth": 200, - "keyword": "vpn", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned from the App Store SERP;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code><br>maximum value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "depth": { + "description": "parsing depth optional field number of results to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", + "type": "integer" + }, + "keyword": { + "description": "keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "type": "string" + }, + "language_code": { + "description": "search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", + "type": "integer" + }, + "location_name": { + "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", + "type": "string" + }, + "pingback_url": { + "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", + "type": "string" + }, + "postback_data": { + "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", + "type": "string" + }, + "postback_url": { + "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", + "type": "string" + }, + "priority": { + "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", + "type": "integer" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + } +} - 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_app_google_app_info_submit8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_id": "org.telegram.messenger", - "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" + ] + } + ] + }, + { + "anyOf": [ + { + "not": { + "required": [ + "postback_url" + ] + } + }, + { + "required": [ + "postback_data" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "language_code": "en", - "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=<strong>org.telegram.messenger</strong></code><br>the id is <code>org.telegram.messenger</code>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - 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" + }, + "language_code": { + "description": "search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", + "type": "integer" + }, + "location_name": { + "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", + "type": "string" + }, + "pingback_url": { + "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", + "type": "string" + }, + "postback_data": { + "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", + "type": "string" + }, + "postback_url": { + "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", + "type": "string" + }, + "priority": { + "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", + "type": "integer" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + } +} - 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_app_google_app_list_submit8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_collection": "topselling_free", - "depth": 100, - "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" + ] + } + ] + }, + { + "anyOf": [ + { + "not": { + "required": [ + "postback_url" + ] + } + }, + { + "required": [ + "postback_data" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_collection": "topselling_free", - "depth": 100, - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "age_rating": { - "description": "<em>filter results by age rating</em><br>optional field<br>you can use this field to filter the results by age rating;<br>possible types of filtering:<br><code>ages_up_to_5</code> — return apps approved for children up to 5 years old;<br><code>ages_6_8</code> — return apps approved for children from 6 to 8 years old;<br><code>ages_9_12</code> — return apps approved for children from 9 to 12 years old;<br>by default, the API returns apps for all ages;<br><strong>Note:</strong> this filter works only in conjunction with the <code>\"category\": \"family\"</code> parameter", - "type": [ - "string", - "null" - ] - }, - "app_category": { - "description": "<em>application category on Google Play</em><br>optional field<br>you can filter the results by app category;<br>example:<br><code>family</code>;<br>you can receive the full list of available categories by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/categories</code><br><strong>Note:</strong> <code>app_category</code> cannot be used if <code>app_collection</code> parameter is set to <code>featured</code>", - "type": [ - "string", - "null" - ] - }, - "app_collection": { - "description": "<em>app collection</em><br><strong>required field</strong><br>app collection on Google Play from which apps will be collected;<br>you can specify the following values:<br><code>featured</code>, <code>topselling_paid</code>, <code>topselling_free</code>, <code>topselling_new_free</code>, <code>topselling_new_paid</code>, <code>topgrossing</code>, <code>movers_shakers</code><br><strong>Note:</strong> if <code>featured</code> is selected, the <code>app_category</code> parameter cannot be used", - "type": "string" - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of apps to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "age_rating": { + "description": "filter results by age rating optional field you can use this field to filter the results by age rating; possible types of filtering: ages_up_to_5 — return apps approved for children up to 5 years old; ages_6_8 — return apps approved for children from 6 to 8 years old; ages_9_12 — return apps approved for children from 9 to 12 years old; by default, the API returns apps for all ages; Note: this filter works only in conjunction with the \"category\": \"family\" parameter", + "type": "string" + }, + "app_category": { + "description": "application category on Google Play optional field you can filter the results by app category; example: family; you can receive the full list of available categories by making a separate request to https://api.dataforseo.com/v3/app_data/google/categories Note: app_category cannot be used if app_collection parameter is set to featured", + "type": "string" + }, + "app_collection": { + "description": "app collection required field app collection on Google Play from which apps will be collected; you can specify the following values: featured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid, topgrossing, movers_shakers Note: if featured is selected, the app_category parameter cannot be used", + "type": "string" + }, + "depth": { + "description": "parsing depth optional field number of apps to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100; maximum value: 200; Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", + "type": "integer" + }, + "language_code": { + "description": "search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", + "type": "integer" + }, + "location_name": { + "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", + "type": "string" + }, + "pingback_url": { + "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", + "type": "string" + }, + "postback_data": { + "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", + "type": "string" + }, + "postback_url": { + "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", + "type": "string" + }, + "priority": { + "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", + "type": "integer" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + } +} - added
Input schema / properties / body / items / requiredAdded value: +[ + "app_collection" +] - 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_app_google_app_listings_search_live5 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "categories": [ - "Tools" - ], - "description": "vpn", - "filters": [ - [ - "item.rating.value", - ">", - 4.5 - ] - ], - "limit": 10, - "order_by": [ - "item.installs_count,asc" - ], - "title": "vpn" - } -] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "categories": [ - "Tools" - ], - "description": "vpn", - "filters": [ - [ - "item.rating.value", - ">", - 4.5 - ] - ], - "limit": 10, - "order_by": [ - "item.installs_count,asc" - ], - "title": "vpn" - } - ], - "properties": { - "categories": { - "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/google/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", - "items": { - "type": "string" - }, - "type": [ - "array", - "null" - ] - }, - "description": { - "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - }, - "filters": { - "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><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>[\"item.rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters</code>", - "items": { - "type": [ - "object", - "null" - ] - }, - "type": [ - "array", - "null" - ] - }, - "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" - ] - }, - "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", - "type": [ - "integer", - "null" - ] - }, - "offset_token": { - "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", - "type": [ - "string", - "null" - ] - }, - "order_by": { - "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.installs_count,asc\"]</code><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>[\"item.rating.value,desc\",\"item.installs_count,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" - ] - }, - "title": { - "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "categories": { + "description": "app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters", + "type": "string" + }, + "filters": { + "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"item.rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters", + "items": {}, + "type": "array" + }, + "limit": { + "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", + "type": "integer" + }, + "offset": { + "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", + "type": "integer" + }, + "offset_token": { + "description": "token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center", + "type": "string" + }, + "order_by": { + "description": "results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: [\"item.installs_count,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: [\"item.rating.value,desc\",\"item.installs_count,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" + }, + "title": { + "description": "keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters", + "type": "string" + } +} - changed
Input schema / properties / body / items / typePrevious value: -[ - "object", - "null" -]New value: +"object" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
post_dataforseo_app_google_app_reviews_submit8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "app_id": "org.telegram.messenger", - "depth": 150, - "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" + ] + } + ] + }, + { + "anyOf": [ + { + "not": { + "required": [ + "postback_url" + ] + } + }, + { + "required": [ + "postback_data" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "app_id": "org.telegram.messenger", - "depth": 150, - "language_code": "en", - "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><code>https://play.google.com/store/apps/details?id=<strong>org.telegram.messenger</strong></code>", - "type": "string" - }, - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;<br>default value: <code>150</code>;<br>maximum value: <code>100000</code>;<br><strong>Your account will be billed per each SERP containing up to 150 results;</strong> <br>Setting depth above 150 may result in additional charges if the search engine returns more than 150 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "language_code": { - "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": "string" - }, - "language_name": { - "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": "string" - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "rating": { - "description": "<em>filter reviews by rating</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>5</code> — return reviews with five-star rating only;<br><code>4</code> — return reviews with four-star rating only;<br><code>3</code> — return reviews with three-star rating only;<br><code>2</code> — return reviews with two-star rating only;<br><code>1</code> — return reviews with one-star rating only;<br>by default, the API returns all reviews regardless of the number of stars", - "type": [ - "integer", - "null" - ] - }, - "sort_by": { - "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>newest</code> — sort by the most recent reviews;<br><code>most_relevant</code> — sort by the most relevant reviews;<br>default rule: <code>most_relevant</code>", - "type": [ - "string", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - 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: https://play.google.com/store/apps/details?id=org.telegram.messenger", + "type": "string" + }, + "depth": { + "description": "parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row; default value: 150; maximum value: 100000; Your account will be billed per each SERP containing up to 150 results; Setting depth above 150 may result in additional charges if the search engine returns more than 150 results.", + "type": "integer" + }, + "language_code": { + "description": "search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", + "type": "integer" + }, + "location_name": { + "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", + "type": "string" + }, + "pingback_url": { + "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", + "type": "string" + }, + "postback_data": { + "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", + "type": "string" + }, + "postback_url": { + "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", + "type": "string" + }, + "priority": { + "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", + "type": "integer" + }, + "rating": { + "description": "filter reviews by rating optional field you can use this field to filter the results; possible types of filtering: 5 — return reviews with five-star rating only; 4 — return reviews with four-star rating only; 3 — return reviews with three-star rating only; 2 — return reviews with two-star rating only; 1 — return reviews with one-star rating only; by default, the API returns all reviews regardless of the number of stars", + "type": "integer" + }, + "sort_by": { + "description": "results sorting parameters optional field you can use this field to sort the results; possible types of sorting: newest — sort by the most recent reviews; most_relevant — sort by the most relevant reviews; default rule: most_relevant", + "type": "string" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + } +} - 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_app_google_app_searches_submit8 fields changed- removed
Input schema / properties / body / exampleRemoved value: -[ - { - "depth": 30, - "keyword": "vpn", - "language_code": "en", - "location_code": 2840 - } -] - added
Input schema / properties / body / items / allOfAdded value: +[ + { + "anyOf": [ + { + "required": [ + "location_name" + ] + }, + { + "required": [ + "location_code" + ] + } + ] + }, + { + "anyOf": [ + { + "not": { + "required": [ + "postback_url" + ] + } + }, + { + "required": [ + "postback_data" + ] + } + ] + } +] - removed
Input schema / properties / body / items / anyOfRemoved value: -[ - { - "example": [ - { - "depth": 30, - "keyword": "vpn", - "language_code": "en", - "location_code": 2840 - } - ], - "properties": { - "depth": { - "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned to be returned from the Google Play SERP;<br>we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "keyword": { - "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", - "type": "string" - }, - "language_code": { - "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", - "type": [ - "string", - "null" - ] - }, - "language_name": { - "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", - "type": [ - "string", - "null" - ] - }, - "location_code": { - "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", - "type": "integer" - }, - "location_name": { - "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", - "type": "string" - }, - "pingback_url": { - "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "postback_data": { - "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", - "type": "string" - }, - "postback_url": { - "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", - "type": [ - "string", - "null" - ] - }, - "priority": { - "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", - "type": [ - "integer", - "null" - ] - }, - "tag": { - "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", - "type": [ - "string", - "null" - ] - } - }, - "type": "object" - } -] - added
Input schema / properties / body / items / propertiesAdded value: +{ + "depth": { + "description": "parsing depth optional field number of results to be returned to be returned from the Google Play SERP; we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row; default value: 30; maximum value: 200; Your account will be billed per each SERP containing up to 30 results; Setting depth above 30 may result in additional charges if the search engine returns more than 30 results.", + "type": "integer" + }, + "keyword": { + "description": "keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", + "type": "string" + }, + "language_code": { + "description": "search engine 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 https://api.dataforseo.com/v3/app_data/google/languages example: en", + "type": "string" + }, + "language_name": { + "description": "full name of search engine 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 language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", + "type": "string" + }, + "location_code": { + "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", + "type": "integer" + }, + "location_name": { + "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", + "type": "string" + }, + "pingback_url": { + "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", + "type": "string" + }, + "postback_data": { + "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", + "type": "string" + }, + "postback_url": { + "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", + "type": "string" + }, + "priority": { + "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", + "type": "integer" + }, + "tag": { + "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", + "type": "string" + } +} - 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_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
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"
43 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_dataforseo_app_apple_app_info_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_app_list_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_app_listings_categories1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_app_reviews_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_app_searches_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_categories1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_apple_locations1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_info_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_info_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_list_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_list_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_listings_categories1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_reviews_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_searches_fetch3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_app_searches_fetch_html3 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time" - added
Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000" - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_categories1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_languages1 field changed- added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
get_dataforseo_app_google_locations1 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
post_dataforseo_app_apple_app_info_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "835599320", + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "835599320", + "language_code": "en", + "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 `https://apps.apple.com/us/app/id<strong>835599320</strong>`<br>the id is `835599320`", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 `https://api.dataforseo.com/v3/app_data/apple/languages`<em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`<br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/pingscript?id=$id`<br>`http://your-server.com/pingscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/postbackscript?id=$id`<br>`http://your-server.com/postbackscript?id=$id&tag=$tag`<br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - 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" - }, - "language_code": { - "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages` example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_app_apple_app_list_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_category": "games", + "app_collection": "top_free_ios", + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_category": "games", + "app_collection": "top_free_ios", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "app_category": { + "description": "application category on the App Storeoptional fieldyou can filter the results by app category;example:lifestyle;you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", + "type": [ + "string", + "null" + ] + }, + "app_collection": { + "description": "app collectionrequired fieldapp collection on App Store from which apps will be collected;you can specify the following values:top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", + "type": "string" + }, + "depth": { + "description": "parsing depthoptional fieldnumber of apps to be returned from the App Store SERP;default value: 100maximum value: 100Your account will be billed per each SERP containing up to 100 results; The cost can be calculated on the Pricing page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "\"search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:en", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:English", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:9061121", + "type": [ + "integer", + "null" + ] + }, + "location_name": { + "description": "full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:West Los Angeles,California,United States", + "type": [ + "string", + "null" + ] + }, + "pingback_url": { + "description": "notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced", + "type": [ + "string", + "null" + ] + }, + "postback_url": { + "description": "URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "app_category": { - "description": "application category on the App Store optional field you can filter the results by app category; example: lifestyle; you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories", - "type": "string" - }, - "app_collection": { - "description": "app collection required field app collection on App Store from which apps will be collected; you can specify the following values: top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios", - "type": "string" - }, - "depth": { - "description": "parsing depth optional field number of apps to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 1000 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", - "type": "integer" - }, - "language_code": { - "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_collection" -] - 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_app_apple_app_listings_search_live5 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "categories": [ + "Utilities" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.rating.value,desc" + ], + "title": "vpn" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "categories": [ + "Utilities" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.rating.value,desc" + ], + "title": "vpn" + } + ], + "properties": { + "categories": { + "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/apple/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "description": { + "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + }, + "filters": { + "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters</code>n", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "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" + ] + }, + "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", + "type": [ + "integer", + "null" + ] + }, + "offset_token": { + "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "order_by": { + "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.rating.value,desc\"]</code><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>[\"item.rating.value,desc\",\"item.rating.value,desc\"]</code>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + }, + "title": { + "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "categories": { - "description": "app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories", - "items": { - "type": "string" - }, - "type": "array" - }, - "description": { - "description": "keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters", - "type": "string" - }, - "filters": { - "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filtersn", - "items": {}, - "type": "array" - }, - "limit": { - "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "offset": { - "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center", - "type": "string" - }, - "order_by": { - "description": "results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: [\"item.rating.value,desc\"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: [\"item.rating.value,desc\",\"item.rating.value,desc\"]", - "items": { - "type": "string" - }, - "type": "array" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - }, - "title": { - "description": "keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_app_apple_app_reviews_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "835599320", + "depth": 200, + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "835599320", + "depth": 200, + "language_code": "en", + "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/id<strong>835599320</strong></code><br>the id is <code>835599320</code>", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;<br>default value: <code>25</code>;<br>maximum value: <code>500</code>;<p><strong>Your account will be billed per each SERP containing up to 25 results;</strong> <br>Setting depth above 25 may result in additional charges if the search engine returns more than 25 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><br>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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "sort_by": { + "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code> — sort by the most recent reviews;<br><code>most_helpful</code> — sort by the most relevant reviews;<br>default rule: <code>most_helpful</code>", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - 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" - }, - "depth": { - "description": "parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row; default value: 25; maximum value: 500; Your account will be billed per each SERP containing up to 25 results; Setting depth above 25 may result in additional charges if the search engine returns more than 25 results.", - "type": "integer" - }, - "language_code": { - "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "sort_by": { - "description": "results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent — sort by the most recent reviews; most_helpful — sort by the most relevant reviews; default rule: most_helpful", - "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_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_app_apple_app_searches_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "depth": 200, + "keyword": "vpn", + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "depth": 200, + "keyword": "vpn", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned from the App Store SERP;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code><br>maximum value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "parsing depth optional field number of results to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", - "type": "integer" - }, - "keyword": { - "description": "keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_app_google_app_info_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "org.telegram.messenger", + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "language_code": "en", + "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=<strong>org.telegram.messenger</strong></code><br>the id is <code>org.telegram.messenger</code>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - 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" - }, - "language_code": { - "description": "search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_app_google_app_list_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_collection": "topselling_free", + "depth": 100, + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_collection": "topselling_free", + "depth": 100, + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "age_rating": { + "description": "<em>filter results by age rating</em><br>optional field<br>you can use this field to filter the results by age rating;<br>possible types of filtering:<br><code>ages_up_to_5</code> — return apps approved for children up to 5 years old;<br><code>ages_6_8</code> — return apps approved for children from 6 to 8 years old;<br><code>ages_9_12</code> — return apps approved for children from 9 to 12 years old;<br>by default, the API returns apps for all ages;<br><strong>Note:</strong> this filter works only in conjunction with the <code>\"category\": \"family\"</code> parameter", + "type": [ + "string", + "null" + ] + }, + "app_category": { + "description": "<em>application category on Google Play</em><br>optional field<br>you can filter the results by app category;<br>example:<br><code>family</code>;<br>you can receive the full list of available categories by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/categories</code><br><strong>Note:</strong> <code>app_category</code> cannot be used if <code>app_collection</code> parameter is set to <code>featured</code>", + "type": [ + "string", + "null" + ] + }, + "app_collection": { + "description": "<em>app collection</em><br><strong>required field</strong><br>app collection on Google Play from which apps will be collected;<br>you can specify the following values:<br><code>featured</code>, <code>topselling_paid</code>, <code>topselling_free</code>, <code>topselling_new_free</code>, <code>topselling_new_paid</code>, <code>topgrossing</code>, <code>movers_shakers</code><br><strong>Note:</strong> if <code>featured</code> is selected, the <code>app_category</code> parameter cannot be used", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of apps to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "age_rating": { - "description": "filter results by age rating optional field you can use this field to filter the results by age rating; possible types of filtering: ages_up_to_5 — return apps approved for children up to 5 years old; ages_6_8 — return apps approved for children from 6 to 8 years old; ages_9_12 — return apps approved for children from 9 to 12 years old; by default, the API returns apps for all ages; Note: this filter works only in conjunction with the \"category\": \"family\" parameter", - "type": "string" - }, - "app_category": { - "description": "application category on Google Play optional field you can filter the results by app category; example: family; you can receive the full list of available categories by making a separate request to https://api.dataforseo.com/v3/app_data/google/categories Note: app_category cannot be used if app_collection parameter is set to featured", - "type": "string" - }, - "app_collection": { - "description": "app collection required field app collection on Google Play from which apps will be collected; you can specify the following values: featured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid, topgrossing, movers_shakers Note: if featured is selected, the app_category parameter cannot be used", - "type": "string" - }, - "depth": { - "description": "parsing depth optional field number of apps to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100; maximum value: 200; Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.", - "type": "integer" - }, - "language_code": { - "description": "search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - removed
Input schema / properties / body / items / requiredRemoved value: -[ - "app_collection" -] - 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_app_google_app_listings_search_live5 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "categories": [ + "Tools" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.installs_count,asc" + ], + "title": "vpn" + } +] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "categories": [ + "Tools" + ], + "description": "vpn", + "filters": [ + [ + "item.rating.value", + ">", + 4.5 + ] + ], + "limit": 10, + "order_by": [ + "item.installs_count,asc" + ], + "title": "vpn" + } + ], + "properties": { + "categories": { + "description": "<em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href=\"http://docs.dataforseo.com/v3/app_data/google/app_listings/categories\" rel=\"noopener noreferrer\" target=\"_blank\">this link</a><br>you can specify <strong>up to 10 categories</strong>", + "items": { + "type": "string" + }, + "type": [ + "array", + "null" + ] + }, + "description": { + "description": "<em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + }, + "filters": { + "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><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>[\"item.rating.value\",\">\",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters</code>", + "items": { + "type": [ + "object", + "null" + ] + }, + "type": [ + "array", + "null" + ] + }, + "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" + ] + }, + "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 entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.", + "type": [ + "integer", + "null" + ] + }, + "offset_token": { + "description": "<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">Help Center</a>", + "type": [ + "string", + "null" + ] + }, + "order_by": { + "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"item.installs_count,asc\"]</code><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>[\"item.rating.value,desc\",\"item.installs_count,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" + ] + }, + "title": { + "description": "<em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "categories": { - "description": "app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories", - "items": { - "type": "string" - }, - "type": "array" - }, - "description": { - "description": "keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters", - "type": "string" - }, - "filters": { - "description": "array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"item.rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters", - "items": {}, - "type": "array" - }, - "limit": { - "description": "the maximum number of returned apps optional field default value: 100 maximum value: 1000", - "type": "integer" - }, - "offset": { - "description": "offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.", - "type": "integer" - }, - "offset_token": { - "description": "token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center", - "type": "string" - }, - "order_by": { - "description": "results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: [\"item.installs_count,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: [\"item.rating.value,desc\",\"item.installs_count,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" - }, - "title": { - "description": "keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters", - "type": "string" - } -} - changed
Input schema / properties / body / items / typePrevious value: -"object"New value: +[ + "object", + "null" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Changed
post_dataforseo_app_google_app_reviews_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "app_id": "org.telegram.messenger", + "depth": 150, + "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" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "app_id": "org.telegram.messenger", + "depth": 150, + "language_code": "en", + "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><code>https://play.google.com/store/apps/details?id=<strong>org.telegram.messenger</strong></code>", + "type": "string" + }, + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;<br>default value: <code>150</code>;<br>maximum value: <code>100000</code>;<br><strong>Your account will be billed per each SERP containing up to 150 results;</strong> <br>Setting depth above 150 may result in additional charges if the search engine returns more than 150 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "language_code": { + "description": "<em>search engine language code</em><br><strong>required field if you don't specify <code>language_name</code></strong><br>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 <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": "string" + }, + "language_name": { + "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify <code>language_code</code></strong><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 <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": "string" + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "rating": { + "description": "<em>filter reviews by rating</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>5</code> — return reviews with five-star rating only;<br><code>4</code> — return reviews with four-star rating only;<br><code>3</code> — return reviews with three-star rating only;<br><code>2</code> — return reviews with two-star rating only;<br><code>1</code> — return reviews with one-star rating only;<br>by default, the API returns all reviews regardless of the number of stars", + "type": [ + "integer", + "null" + ] + }, + "sort_by": { + "description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>newest</code> — sort by the most recent reviews;<br><code>most_relevant</code> — sort by the most relevant reviews;<br>default rule: <code>most_relevant</code>", + "type": [ + "string", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - 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: https://play.google.com/store/apps/details?id=org.telegram.messenger", - "type": "string" - }, - "depth": { - "description": "parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row; default value: 150; maximum value: 100000; Your account will be billed per each SERP containing up to 150 results; Setting depth above 150 may result in additional charges if the search engine returns more than 150 results.", - "type": "integer" - }, - "language_code": { - "description": "search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "rating": { - "description": "filter reviews by rating optional field you can use this field to filter the results; possible types of filtering: 5 — return reviews with five-star rating only; 4 — return reviews with four-star rating only; 3 — return reviews with three-star rating only; 2 — return reviews with two-star rating only; 1 — return reviews with one-star rating only; by default, the API returns all reviews regardless of the number of stars", - "type": "integer" - }, - "sort_by": { - "description": "results sorting parameters optional field you can use this field to sort the results; possible types of sorting: newest — sort by the most recent reviews; most_relevant — sort by the most relevant reviews; default rule: most_relevant", - "type": "string" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_app_google_app_searches_submit8 fields changed- added
Input schema / properties / body / exampleAdded value: +[ + { + "depth": 30, + "keyword": "vpn", + "language_code": "en", + "location_code": 2840 + } +] - removed
Input schema / properties / body / items / allOfRemoved value: -[ - { - "anyOf": [ - { - "required": [ - "location_name" - ] - }, - { - "required": [ - "location_code" - ] - } - ] - }, - { - "anyOf": [ - { - "not": { - "required": [ - "postback_url" - ] - } - }, - { - "required": [ - "postback_data" - ] - } - ] - } -] - added
Input schema / properties / body / items / anyOfAdded value: +[ + { + "example": [ + { + "depth": 30, + "keyword": "vpn", + "language_code": "en", + "location_code": 2840 + } + ], + "properties": { + "depth": { + "description": "<em>parsing depth</em><br>optional field<br>number of results to be returned to be returned from the Google Play SERP;<br>we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "keyword": { + "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>", + "type": "string" + }, + "language_code": { + "description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>", + "type": [ + "string", + "null" + ] + }, + "language_name": { + "description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class=\"long-string\">English</code>", + "type": [ + "string", + "null" + ] + }, + "location_code": { + "description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">9061121</code>", + "type": "integer" + }, + "location_name": { + "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code></strong><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class=\"long-string\">West Los Angeles,California,United States</code>", + "type": "string" + }, + "pingback_url": { + "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "postback_data": { + "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>", + "type": "string" + }, + "postback_url": { + "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>", + "type": [ + "string", + "null" + ] + }, + "priority": { + "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/google-play\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.", + "type": [ + "integer", + "null" + ] + }, + "tag": { + "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response", + "type": [ + "string", + "null" + ] + } + }, + "type": "object" + } +] - removed
Input schema / properties / body / items / propertiesRemoved value: -{ - "depth": { - "description": "parsing depth optional field number of results to be returned to be returned from the Google Play SERP; we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row; default value: 30; maximum value: 200; Your account will be billed per each SERP containing up to 30 results; Setting depth above 30 may result in additional charges if the search engine returns more than 30 results.", - "type": "integer" - }, - "keyword": { - "description": "keyword required field you can specify up to 700 characters in the keyword field; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article", - "type": "string" - }, - "language_code": { - "description": "search engine 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 https://api.dataforseo.com/v3/app_data/google/languages example: en", - "type": "string" - }, - "language_name": { - "description": "full name of search engine 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 language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: English", - "type": "string" - }, - "location_code": { - "description": "search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: 9061121", - "type": "integer" - }, - "location_name": { - "description": "full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/locations example: West Los Angeles,California,United States", - "type": "string" - }, - "pingback_url": { - "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "postback_data": { - "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html", - "type": "string" - }, - "postback_url": { - "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23", - "type": "string" - }, - "priority": { - "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.", - "type": "integer" - }, - "tag": { - "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response", - "type": "string" - } -} - 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_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
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" +}
8 tool updates
- Changed
post_dataforseo_app_apple_app_info_submit1 field changed- changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_app_apple_app_list_submit2 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of apps to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 1000 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of apps to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 1000 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results." - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_app_apple_app_reviews_submit2 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row; default value: 25; maximum value: 500; Your account will be billed per each SERP containing up to 25 results; Setting depth above 25 may result in additional charges if the search engine returns more than 25 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row; default value: 25; maximum value: 500; Your account will be billed per each SERP containing up to 25 results; Setting depth above 25 may result in additional charges if the search engine returns more than 25 results." - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_app_apple_app_searches_submit2 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of results to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results." - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_app_google_app_info_submit1 field changed- changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_app_google_app_list_submit2 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of apps to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100; maximum value: 200; Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of apps to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100; maximum value: 200; Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results." - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_app_google_app_reviews_submit2 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row; default value: 150; maximum value: 100000; Your account will be billed per each SERP containing up to 150 results; Setting depth above 150 may result in additional charges if the search engine returns more than 150 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row; default value: 150; maximum value: 100000; Your account will be billed per each SERP containing up to 150 results; Setting depth above 150 may result in additional charges if the search engine returns more than 150 results." - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
- Changed
post_dataforseo_app_google_app_searches_submit2 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results to be returned to be returned from the Google Play SERP; we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row; default value: 30; maximum value: 200; Your account will be billed per each SERP containing up to 30 results; Setting depth above 30 may result in additional charges if the search engine returns more than 30 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of results to be returned to be returned from the Google Play SERP; we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row; default value: 30; maximum value: 200; Your account will be billed per each SERP containing up to 30 results; Setting depth above 30 may result in additional charges if the search engine returns more than 30 results." - changed
Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."
19 tool updates
- Changed
get_dataforseo_app_apple_app_info_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_app_apple_app_list_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_app_apple_app_reviews_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_app_apple_app_searches_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_app_google_app_info_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_app_google_app_info_fetch_html1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"
- Changed
get_dataforseo_app_google_app_list_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_app_google_app_list_fetch_html1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"
- Changed
get_dataforseo_app_google_app_reviews_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_app_google_app_searches_fetch1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time"
- Changed
get_dataforseo_app_google_app_searches_fetch_html1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time"
- Changed
post_dataforseo_app_apple_app_info_submit1 field changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: en"New value: +"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages` example: en"
- Changed
post_dataforseo_app_apple_app_list_submit1 field changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: en"New value: +"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn"
- Changed
post_dataforseo_app_apple_app_listings_search_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, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters by making a separate request to https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters"New value: +"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filtersn"
- Changed
post_dataforseo_app_apple_app_reviews_submit2 fields changed- changed
Input schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 50, because our system processes 50 reviews in a row; default value: 50; maximum value: 500; Your account will be billed per each SERP containing up to 50 results; Setting depth above 50 may result in additional charges if the search engine returns more than 50 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row; default value: 25; maximum value: 500; Your account will be billed per each SERP containing up to 25 results; Setting depth above 25 may result in additional charges if the search engine returns more than 25 results; The cost can be calculated on the Pricing page." - changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: en"New value: +"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn"
- Changed
post_dataforseo_app_apple_app_searches_submit1 field changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"search engine language code required field if language_name is not specified if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: en"New value: +"search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: enn"
- Changed
post_dataforseo_app_google_app_info_submit1 field changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"search engine language code required field if language_name is not specified if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en"New value: +"search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en"
- Changed
post_dataforseo_app_google_app_list_submit1 field changed- changed
Input schema / properties / body / items / properties / language_code / descriptionPrevious value: -"search engine language code required field if language_name is not specified if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en"New value: +"search engine language code required field if language_name is not specified if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages example: en"
- Changed
post_dataforseo_app_google_app_listings_search_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, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"item.rating.value\",\">\",3] you can receive the list of available filters by making a separate request to https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters"New value: +"array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: [\"item.rating.value\",\">\",3] you can receive the list of available filters_by making a separate request to https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters"
42 tool updates
- First observed
batch_use - First observed
get_dataforseo_app_apple_app_info_fetch - First observed
get_dataforseo_app_apple_app_list_fetch - First observed
get_dataforseo_app_apple_app_listings_categories - First observed
get_dataforseo_app_apple_app_reviews_fetch - First observed
get_dataforseo_app_apple_app_searches_fetch - First observed
get_dataforseo_app_apple_categories - First observed
get_dataforseo_app_apple_languages - First observed
get_dataforseo_app_apple_locations - First observed
get_dataforseo_app_google_app_info_fetch - First observed
get_dataforseo_app_google_app_info_fetch_html - First observed
get_dataforseo_app_google_app_list_fetch - First observed
get_dataforseo_app_google_app_list_fetch_html - First observed
get_dataforseo_app_google_app_listings_categories - First observed
get_dataforseo_app_google_app_reviews_fetch - First observed
get_dataforseo_app_google_app_searches_fetch - First observed
get_dataforseo_app_google_app_searches_fetch_html - First observed
get_dataforseo_app_google_categories - First observed
get_dataforseo_app_google_languages - First observed
get_dataforseo_app_google_locations - First observed
get_details - First observed
list_categories - First observed
post_dataforseo_app_apple_app_info_submit - First observed
post_dataforseo_app_apple_app_list_submit - First observed
post_dataforseo_app_apple_app_listings_search_live - First observed
post_dataforseo_app_apple_app_reviews_submit - First observed
post_dataforseo_app_apple_app_searches_submit - First observed
post_dataforseo_app_google_app_info_submit - First observed
post_dataforseo_app_google_app_list_submit - First observed
post_dataforseo_app_google_app_listings_search_live - First observed
post_dataforseo_app_google_app_reviews_submit - First observed
post_dataforseo_app_google_app_searches_submit - 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_keywords_for_app_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 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 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.
Your agent needs what customers say in public — Google Business profiles and reviews, Trustpilot, Tripadvisor, hotel listings and the Q&A under a listing. **What you can ask for** • "Pull this business's Google reviews and group the complaints." • "What do Trustpilot reviewers say about this competitor?" • "Find hotels matching this search and their live prices." • "What questions are people asking on this Google listing, and are they answered?" • "Search listings for this category in this city." **How to use it** Point any MCP client at https://mcp.aisa.one/seo-business/mcp and sign in with OAuth — there is no key to create or paste. 22 tools: Google Business info, reviews, extended reviews, updates and Q&A; Trustpilot and Tripadvisor search and reviews; Google hotel info and searches; business listing search; plus Reddit and Pinterest signals for a business. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Read the reviews here, then ask the same agent what that business ranks for or who links to it — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Your agent needs live data — a competitor's traffic, who to contact there, what people are saying, what Google and ChatGPT answer about you, a company's filings. Normally that is six vendor accounts, six sets of keys and six SDKs. This is one URL. **What you can ask for** • "How much traffic does stripe.com get, where does it come from, and who competes for the same keywords?" • "Find 20 Series-B fintech companies in Germany and the heads of marketing there, with emails." • "Does ChatGPT mention our brand when someone asks for the best CRM — and what does it cite?" • "What is X saying about $NVDA today, and what did the stock actually do?" • "Search the web for this, then scrape the three best pages into markdown." **How to use it** Point any MCP client at https://mcp.aisa.one/mcp and sign in with OAuth — there is no key to create or paste. Then just ask: the agent calls search to find the right operation and use to run it. **Why this rather than the source** 26 sources behind one account and one bill — DataForSEO, Semrush, Ahrefs, Similarweb, Apollo, X/Twitter, Instagram, Reddit, Pinterest, YouTube, Tavily, Exa, Perplexity, Firecrawl, CoinGecko, Kalshi, Polymarket, AgentMail and more, 580+ operations. tools/list returns five tools, not 580, so the introduction does not eat your context window. **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** One slice at a time: https://mcp.aisa.one/seo/mcp · /finance/mcp · /social/mcp · /search/mcp · /sales/mcp · /mail/mcp · /gtm/mcp, or a single provider like /twitter-api/mcp. Same account, fewer tools listed, and search still reaches everything. Full list at https://mcp.aisa.one/servers
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceA remote MCP server that gives AI agents structured access to Google Play and the Apple App Store — search apps, fetch metadata, pull reviews.MIT

GetAppNiche MCPofficial
AlicenseNot gradedqualityAmaintenanceEnables AI agents to query live App Store and Google Play data, including app search, revenue/download metrics, keyword difficulty, and reviews, via a hosted MCP server with API-key authentication.76 npmMIT- AlicenseNot gradedqualityBmaintenanceProvides live App Store and Google Play data as MCP tools, enabling search, app details, reviews, charts, estimates, and more through natural language.1MIT
- FlicenseNot gradedqualityBmaintenanceMCP server for App Store Optimization, enabling AI agents to read rankings, keywords, competitors, reviews, and revenue, and manage metadata with human approval.11-
Glama MCP Gateway
Add one secure layer between your agents and this server.