- REFERENCE
- COMMON PARAMS
- LIST OF APIS
App Keyword
POST
/expose/keyword/metrics-rank
Cost Type | Cost Credits |
---|---|
Request Credits | 1 |
Cost Type | Cost Credits |
---|---|
Base Credits | 10 |
Cost Type | Cost Credits |
---|---|
Base Credits | 10 |
Request
Header Params
x-openapi-key
string
required
Default:
Your License
Body Params application/json
appId
string
required
region
string
required
Default:
US
metrics
array[string]
required
Allowed values:
RANKINSTALL
keywords
array[string] | null
optional
<= 5 items
device
enum<string> | enum<null>
optional
Allowed values:
IPHONEIPAD
timezone
integer | null
required
Example
{
"appId": "416048305",
"region": "KR",
"metrics": [
"RANK",
"INSTALL"
],
"keywords": [
"alight motion",
"북플레이",
"alight motion"
],
"device": "IPHONE",
"timezone": 0
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.foxdata.com/apiv1/expose/keyword/metrics-rank' \
--header 'x-openapi-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
"appId": "416048305",
"region": "KR",
"metrics": [
"RANK",
"INSTALL"
],
"keywords": [
"alight motion",
"북플레이",
"alight motion"
],
"device": "IPHONE",
"timezone": 0
}'
Responses
🟢200Success
application/json
Body
requestParam
object (KeywordRankMetricsQuery)
optional
appId
string | null
required
region
string | null
required
Default:
US
metrics
array[string] | null
required
Allowed values:
RANKINSTALL
keywords
array[string] | null
optional
<= 5 items
device
enum<string> | enum<null>
optional
Allowed values:
IPHONEIPAD
timezone
integer | null
required
result
array [object {3}] | null
optional
keyword
string | null
optional
rank
object (KeywordInfo)
optional
installs
object (KeywordInfo)
optional
creditsCost
object (OpenApiPointCostVO)
optional
requestCredits
integer | null
optional
baseCredits
integer | null
optional
extraCredits
integer | null
optional
totalCostCredits
integer | null
optional
Example
{"code":200,"msg":"success","data":{"requestParam":{"appId":"416048305","region":"KR","metrics":["RANK","INSTALL"],"keywords":["alight motion","북플레이","alight motion"],"device":"IPHONE","timezone":0},"result":[{"keyword":"alight motion","rank":{"value":37,"date":"2024-05-14"}},{"keyword":"북플레이","rank":{"value":137,"date":"2024-05-14"}}],"creditsCost":{"requestCredits":1,"baseCredits":20,"extraCredits":0,"totalCostCredits":21}}}