FoxData Open API
My License
My License
  1. LIST OF APIS
  • REFERENCE
    • Make Your First API Request
    • API Billing Rules
  • COMMON PARAMS
    • App Store Categories
    • Google Play Categories
    • Supported Countries/Languages
  • LIST OF APIS
    • App Metadata
      POST
    • App Metadata History
      POST
    • App Category Ranking
      POST
    • App Category Ranking History
      POST
    • App Metrics
      POST
    • App Metrics History
      POST
    • App Keyword
      POST
    • App Keyword History
      POST
    • Keywords Metrics
      POST
    • Keywords Metrics History
      POST
  1. LIST OF APIS

App Keyword

POST
/expose/keyword/metrics-rank
Credits Cost
Cost TypeCost Credits
Request Credits1
Credits Cost of Each Metrics
Rank
Cost TypeCost Credits
Base Credits10
Installs
Cost TypeCost Credits
Base Credits10

Request

Header Params
x-openapi-key
string 
required
Default:
Your License
Body Params application/json
appId
string 
required
Application ID or packageName
region
string 
required
Two character region code,like US.
Default:
US
metrics
array[string]
required
Keyword Metrics
Allowed values:
RANKINSTALL
keywords
array[string] | null 
optional
Filtered Keywords
<= 5 items
device
enum<string>  | enum<null> 
optional
App Store Device, only for AppStore query.
Allowed values:
IPHONEIPAD
timezone
integer  | null 
required
Your timezone,enter 8 for UTC+8,enter -7 for UTC-7.
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
Your request param.
appId
string  | null 
required
Application ID or packageName
region
string  | null 
required
Two character region code,like US.
Default:
US
metrics
array[string] | null 
required
Keyword Metrics
Allowed values:
RANKINSTALL
keywords
array[string] | null 
optional
Filtered Keywords
<= 5 items
device
enum<string>  | enum<null> 
optional
App Store Device, only for AppStore query.
Allowed values:
IPHONEIPAD
timezone
integer  | null 
required
Your timezone,enter 8 for UTC+8,enter -7 for UTC-7.
result
array [object {3}]  | null 
optional
Your response.
keyword
string  | null 
optional
Keyword
rank
object (KeywordInfo) 
optional
Rank
installs
object (KeywordInfo) 
optional
Installs
creditsCost
object (OpenApiPointCostVO) 
optional
Credits cost info.
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
    }
  }
}
Previous
App Metrics History
Next
App Keyword History
Built with