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 Metrics History

POST
/expose/app/metrics-history
Credits Cost
Cost TypeCost Credits
Request Credits1
Credits Cost of Each Metrics
Estimated Downloads
Cost TypeCost Credits
Base Credits250
Extra Credits25 per day
Estimated Revenue
Cost TypeCost Credits
Base Credits250
Extra Credits25 per day
Ratings
Cost TypeCost Credits
Base Credits10
Extra Credits1 per day

Request

Header Params
x-openapi-key
string 
required
Default:
Your License
Body Params application/json
Your request param.
appId
string 
required
Application ID or packageName
region
string 
required
Two character region code,like US.
Default:
US
metrics
array[string]
optional
Allowed values:
DOWNLOAD_FORECASTREVENUE_FORECASTRATING
device
enum<string>  | enum<null> 
optional
Allowed values:
IPHONEIPAD
start
string  | null 
required
Start Date
end
string  | null 
required
End Date
Example
{
  "appId": "416048305",
  "region": "KR",
  "metrics": [
    "RATING",
    "DOWNLOAD_FORECAST"
  ],
  "device": "IPHONE",
  "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/app/metrics-history' \
--header 'x-openapi-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "416048305",
    "region": "KR",
    "metrics": [
        "RATING",
        "DOWNLOAD_FORECAST"
    ],
    "device": "IPHONE",
    "start": "2024-05-10",
    "end": "2024-05-14"
}'

Responses

🟢200Success
application/json
Body
requestParam
object (AppMetricsHistoryQuery) 
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
App Metrics List
Allowed values:
DOWNLOAD_FORECASTREVENUE_FORECASTVISIBILITY_SCORERATING
device
enum<string>  | enum<null> 
optional
App Store Device, only for AppStore query.
Allowed values:
IPHONEIPAD
start
string  | null 
required
Start Date
end
string  | null 
required
End Date
result
object 
optional
Your response.
downloadForecast
array[object (DailyValue) {2}]  | null 
optional
Estimated Downloads
revenueForecast
array[object (DailyValue) {2}]  | null 
optional
Estimated Revenue
visibilityScore
array[object (DailyValue) {2}]  | null 
optional
Visiblity Score
rating
array[object (RatingDetailVO) {2}]  | null 
optional
Ratings
ratingChange
array[object (RatingDetailVO) {2}]  | null 
optional
Ratings Change
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": {
      "region": "KR",
      "appId": "416048305",
      "metrics": [
        "RATING",
        "DOWNLOAD_FORECAST"
      ],
      "device": "IPHONE",
      "start": "2024-05-10",
      "end": "2024-05-14"
    },
    "result": {
      "downloadForecast": [
        {
          "date": "2024-05-10",
          "value": 1081
        },
        {
          "date": "2024-05-11",
          "value": 1387
        },
        {
          "date": "2024-05-12",
          "value": 1313
        },
        {
          "date": "2024-05-13",
          "value": 1218
        },
        {
          "date": "2024-05-14",
          "value": 1146
        }
      ],
      "rating": [
        {
          "date": "2024-05-10",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-10",
          "value": {
            "ratingCount": [
              2102,
              722,
              1673,
              3328,
              27785
            ],
            "totalCount": 35610,
            "avgScore": 4.52
          }
        },
        {
          "date": "2024-05-11",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-11",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-12",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-12",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-13",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-13",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-14",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-14",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        }
      ],
      "ratingChange": [
        {
          "date": "2024-05-10",
          "value": {
            "ratingCount": [
              2102,
              722,
              1673,
              3328,
              27785
            ],
            "totalCount": 35610,
            "avgScore": 4.52
          }
        },
        {
          "date": "2024-05-11",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-12",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-13",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        },
        {
          "date": "2024-05-14",
          "value": {
            "ratingCount": [
              0,
              0,
              0,
              0,
              0
            ],
            "totalCount": 0,
            "avgScore": 0
          }
        }
      ]
    },
    "creditsCost": {
      "requestCredits": 1,
      "baseCredits": 260,
      "extraCredits": 109,
      "totalCostCredits": 370
    }
  }
}
Modified at 2024-05-17 03:01:36
Previous
App Metrics
Next
App Keyword
Built with