Star Rating - Get Rating Platforms and Versions
Endpoint
/o?method=star
Overview
Returns the platforms and app versions for which star ratings were recorded in the requested period. Use it to fill the platform and version filters of Get Feedback Data.
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. |
api_key | String | Conditional | Required if auth_token is not provided. |
auth_token | String | Conditional | Required if api_key is not provided. |
app_id | String | Yes | App ID. |
period | String/Array | Yes | prevMonth, month, day, yesterday, hour, <number>days (for example 30days), or a custom range as a JSON array. |
Examples
Read platforms and versions of the last 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 of String | App versions recorded for the platform. The platform name is the key. |
Error Responses
400
{
"result": "Missing request parameter: period"
}
400
{
"result": "Bad request parameter: period"
}
Authentication and authorization failures are returned by the common auth layer.
Behavior
- Returns an empty object when no ratings were recorded in the period.