DataForSEO: Dataforseo Labs Apple Keywords For App Live

This endpoint will provide you with a list of keywords for which the target app ranks on App Store.

Tool ID: dataforseo_dataforseo_labs_apple_keywords_for_app_live

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_dataforseo_labs_apple_keywords_for_app_live',
  {
    "app_id": "app_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute dataforseo_dataforseo_labs_apple_keywords_for_app_live --input '{
  "app_id": "app_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}

Use deepline describe dataforseo_dataforseo_labs_apple_keywords_for_app_live --json for the latest machine-readable contract.

Input reference

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.

Name	Type	Required	Default	Details
`payload.app_id`	`string`	Yes	—	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
`payload.location_name`	`string`	No	—	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
`payload.location_code`	`integer`	No	—	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
`payload.language_name`	`string`	No	—	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
`payload.language_code`	`string`	No	—	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
`payload.filters`	`array`	No	—	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 - See the live schema for the complete constraint.
`payload.order_by`	`array`	No	—	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: See the live schema for the complete constraint.
`payload.limit`	`integer`	No	—	the maximum number of returned keywords optional field default value: 100 maximum value: 1000
`payload.offset`	`integer`	No	—	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
`payload.tag`	`string`	No	—	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

Output reference

Top-level response envelope for dataforseo_dataforseo_labs_apple_keywords_for_app_live.

Name	Type	Required	Default	Details
`result.version`	`string`	Yes	—	the current version of the API
`result.status_code`	`integer`	Yes	—	general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
`result.status_message`	`string`	Yes	—	general informational message you can find the full list of general informational messages here
`result.time`	`string`	Yes	—	execution time, seconds
`result.tasks_count`	`integer`	Yes	—	the number of tasks in the tasks array
`result.tasks_error`	`integer`	Yes	—	the number of tasks in the tasks array returned with an error
`result.tasks`	`array`	Yes	—	array of tasks

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0.01 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation