- REFERENCE
- COMMON PARAMS
- LIST OF APIS
Keywords Metrics History
POST
/expose/keyword/metrics-history
Cost Type | Cost Credits |
---|---|
Request Credits | 1 |
Cost Type | Cost Credits |
---|---|
Base Credits | 10 |
Extra Credits | 1 per day |
Cost Type | Cost Credits |
---|---|
Base Credits | 10 |
Extra Credits | 1 per day |
Request
Header Params
x-openapi-key
string
required
Default:
Your License
Body Params application/json
Your request param.
appId
string
required
keywords
array[string] | null
optional
<= 5 items
start
string | null
required
end
string | null
required
region
string
required
Default:
US
device
enum<string> | enum<null>
optional
Allowed values:
IPHONEIPAD
Default:
{value: 0}
timezone
integer | null
required
Default:
0
metrics
array[string]
required
Allowed values:
POPNUM
Example
{
"appId": "416048305",
"region": "KR",
"metrics": [
"POP",
"NUM"
],
"keywords": [
"alight motion",
"북플레이",
"alight motion"
],
"device": "IPHONE",
"timezone": 8,
"start": "2024-05-10",
"end": "2024-05-14"
}
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-history' \
--header 'x-openapi-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
"appId": "416048305",
"region": "KR",
"metrics": [
"POP",
"NUM"
],
"keywords": [
"alight motion",
"북플레이",
"alight motion"
],
"device": "IPHONE",
"timezone": 8,
"start": "2024-05-10",
"end": "2024-05-14"
}'
Responses
🟢200Success
application/json
Body
requestParam
object (KeywordMetricsHistoryQuery)
optional
appId
string | null
required
keywords
array[string] | null
optional
<= 5 items
start
string | null
required
end
string | null
required
region
string | null
required
Default:
US
device
enum<string> | enum<null>
optional
Allowed values:
IPHONEIPAD
Default:
{value: 0}
timezone
integer | null
required
Default:
0
metrics
array[string] | null
required
Allowed values:
POPNUMRELATIONDIFFCHANCETAG
result
array [object {3}] | null
optional
keyword
string | null
optional
pop
array[object (KeywordInfo) {2}] | null
optional
num
array[object (KeywordInfo) {2}] | null
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","keywords":["alight motion","북플레이","alight motion"],"start":"2024-05-10","end":"2024-05-12","region":"KR","device":"IPHONE","timezone":0,"metrics":["POP","NUM","TAG"]},"result":[{"keyword":"alight motion","pop":[{"value":null,"date":"2024-05-10"},{"value":null,"date":"2024-05-11"},{"value":null,"date":"2024-05-12"}],"num":[{"value":234,"date":"2024-05-10"},{"value":237,"date":"2024-05-11"},{"value":237,"date":"2024-05-12"}],"tag":{"brand":[{"appId":"1459833443","appName":"Alight Motion","icon":"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/37/2b/3c/372b3c49-d733-f623-376b-f98759af471a/AppIcon-0-0-1x_U007emarketing-0-4-0-0-0-0-85-220.png/88x88w.png"}],"asa":[{"appId":"416048305","appName":"Meitu 메이투 - 베스트 보정 앱 & AI 카툰","icon":"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/48/af/6e/48af6ed0-e840-dc22-09a6-d0dd4eddec2f/AppIcon-0-0-1x_U007emarketing-0-7-0-85-220.png/88x88w.png"},{"appId":"389801252","appName":"Instagram","icon":"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/21/d3/08/21d308ff-6354-fd2a-8844-4354ba710dab/Prod-0-0-1x_U007emarketing-0-7-0-85-220.png/88x88w.png"},{"appId":"1006386292","appName":"만들기 비디오 으로 & 노래 편집기","icon":"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/38/a2/bc/38a2bc9d-4457-6dbd-0559-f82c0cfd4b36/AppIcon-0-0-1x_U007epad-0-0-0-0-0-0-P3-0-0-0-GLES2_U002c0-512MB-85-220-0-0.png/88x88w.png"}],"meta":null}},{"keyword":"북플레이","pop":[{"value":null,"date":"2024-05-10"},{"value":null,"date":"2024-05-11"},{"value":null,"date":"2024-05-12"}],"num":[{"value":218,"date":"2024-05-10"},{"value":219,"date":"2024-05-11"},{"value":218,"date":"2024-05-12"}],"tag":{"brand":null,"asa":[{"appId":"1619262637","appName":"WePlay - 파티게임","icon":"https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/7d/5f/8e/7d5f8e47-1fa6-93f1-08db-7c44321e8d6f/AppIcon-KR-0-0-1x_U007epad-0-0-0-sRGB-85-220.png/88x88w.png"},{"appId":"947258826","appName":"마피아42","icon":"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/f0/83/78/f0837892-1b84-9639-6261-fc350f2e339c/AppIcon-0-0-1x_U007emarketing-0-7-0-sRGB-85-220.png/88x88w.png"},{"appId":"1074569961","appName":"원티드 - 취업·이직, 프리랜서, 커리어 성장","icon":"https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/3b/df/c2/3bdfc2f1-8bca-65f6-c90f-c4df5bc4cdc1/AppIcon-0-0-1x_U007ephone-0-0-85-220.png/88x88w.png"}],"meta":null}}],"creditsCost":{"requestCredits":1,"baseCredits":30,"extraCredits":4,"totalCostCredits":35}}}