OverviewPlatformsAPI Reference
Analytics

Get review stats

Returns stats on reviews your keywords collect from the App Store, Google Play, Trustpilot and Google Maps. You get the count, average stars, the star distribution, replies and open 1 and 2 star reviews, for the workspace and per review page. Each page has a series of average stars per bucket, and the report lists the tags of unhappy reviews. Two keywords matching one review count it once. Pick the period with range (7d, 30d, 90d or 365d up to today) or with from and to. Days follow timezone, UTC by default. keywordIds and platforms narrow the data, and compare=true adds the equally long period just before. Dates are publish dates.

GET
/v1/analytics/reviews

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Query Parameters

range?string

A preset period up to today, 30d by default. Ignored when you send from or to.

Value in

  • "7d"
  • "30d"
  • "90d"
  • "365d"
from?string

Start date in timezone, as YYYY-MM-DD. That day is included.

Match^\d{4}-\d{2}-\d{2}$
to?string

End date in timezone, as YYYY-MM-DD, included. Defaults to today.

Match^\d{4}-\d{2}-\d{2}$
keywordIds?array<>|

Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords.

Itemsitems <= 50
platforms?array<>

Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms.

Itemsitems <= 20
compare?boolean

true adds the equally long period just before as previous.

timezone?string

The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period.

Lengthlength <= 64
bucket?string

The step of each series, day or week. Days by default for periods up to 90 days.

Value in

  • "day"
  • "week"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/analytics/reviews"
{  "window": {    "from": "string",    "to": "string",    "days": 0,    "timezone": "string",    "bucket": "day"  },  "totals": {    "reviews": 0,    "averageRating": 1,    "distribution": {      "1": 0,      "2": 0,      "3": 0,      "4": 0,      "5": 0    },    "responded": 0,    "openNegative": 0  },  "tags": [    {      "tag": "string",      "count": 0    }  ],  "pages": [    {      "reviews": 0,      "averageRating": 1,      "distribution": {        "1": 0,        "2": 0,        "3": 0,        "4": 0,        "5": 0      },      "responded": 0,      "openNegative": 0,      "platform": "appstore",      "id": "string",      "url": "string",      "series": [        {          "date": "string",          "reviews": 0,          "averageRating": 1        }      ],      "previous": {        "reviews": 0,        "averageRating": 1      }    }  ],  "previous": {    "reviews": 0,    "averageRating": 1,    "distribution": {      "1": 0,      "2": 0,      "3": 0,      "4": 0,      "5": 0    },    "responded": 0,    "openNegative": 0  }}
Was this page helpful?

Get summary counts

Returns matched and relevant mentions, unique posts and people, sentiment, buying intent and questions, estimated reach, and the triage status of the matches. Pick the period with `range` (7d, 30d, 90d or 365d up to today) or with `from` and `to`. Days follow `timezone`, UTC by default. `keywordIds` and `platforms` narrow the data, and `compare=true` adds the equally long period just before. Dates are publish dates.

Get share of voice

Returns each keyword with matches in the period, its counts and its share of all brand and competitor matches. Topic keywords are counted but not part of the split. Pick the period with `range` (7d, 30d, 90d or 365d up to today) or with `from` and `to`. Days follow `timezone`, UTC by default. `keywordIds` and `platforms` narrow the data, and `compare=true` adds the equally long period just before. Dates are publish dates.