Star Rating - Get Ratings Metadata
Endpoint
/o?method=star
Overview
Returns the platforms and platform version and rating combinations for which star ratings were recorded in a period.
Authentication
Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.
Permissions
Requires star_rating Read permission.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
method | String | Yes | Must be star. |
app_id | String | Yes | App id. |
period | String or Array | Yes | Period value: month, day, yesterday, hour, prevMonth, {number}days such as 30days, or a date range array. |
api_key | String | Conditional | Required if auth_token is not provided. |
auth_token | String | Conditional | Required if api_key is not provided. |
Examples
Read rating metadata for 30 days
/o?method=star&api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&period=30days
Response
Success Response
{
"Android": [
"3:2",
"1:7"
],
"iOS": [
"1:1",
"2:5"
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
<platform> | Array | Platform name as the key. The array lists the platform version and rating combinations recorded for that platform in the period. |
Error Responses
400
{
"result": "Missing request parameter: period"
}
400
{
"result": "Bad request parameter: period"
}
Behavior
- Permission is checked before the parameters are validated.
- Returns an empty object when no ratings were recorded in the period.