Followed Keyword Lists

get

https://public-api.apptweak.com/api/public/apptweak/user/keyword_lists

Retrieve keyword lists grouped by workspace and by followed application configuration: store, country, language and device.

By default only list names and keyword counts are returned; pass include_keywords=true to also get the keywords themselves.

Price

Datapoint	Comment	Credits/request
Keyword list	Hash containing your keyword list by workspace and by app.	0

Query Params

workspace_ids

array of int32s

required

Comma-separated list of workspace IDs to read. At least one is required — call /user/workspaces to list the IDs your user has access to.

workspace_ids*

application_ids

array of strings

Comma-separated list of store application IDs (iOS numeric ID or Android package name). Restricts the response to those applications.

application_ids

stores

array of strings

Comma-separated list of stores to keep, among google, itunes.

stores

Allowed:

country_codes

array of strings

Comma-separated country codes (us,gb); accepted values: GET /api/public/apptweak/countries with store=ios or store=android. Keeps only the lists in those countries.

country_codes

language_codes

array of strings

Comma-separated AppTweak language codes, not always ISO: US English is us, US Spanish sp. Accepted values: GET /api/public/apptweak/languages with store=ios or store=android. Keeps only the lists in those languages.

language_codes

devices

array of strings

Comma-separated list of devices to keep, among android, iphone, ipad.

devices

Allowed:

include_keywords

boolean

Defaults to false

When true, every keyword list also returns its keyword values. Defaults to false, which returns counts only.

Responses

401

Unauthorized. Unknown or missing API token.

403

Forbidden. Not enough credits to perform the request.

422

Validation error. Returned when a parameter is invalid.

429

Rate limit exceeded: 20 requests per minute on this endpoint, 60 per 10 seconds across the API. Retry with backoff.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response.