Account reports: dashboard

The individual charts and counts that make up a business's dashboard.

The individual charts and counts that make up a business's dashboard: totals, trends, rating breakdown, site distribution, sentiment, top locations, rankings.

Each endpoint returns one widget's data so you can build a dashboard from the pieces you want.

You'll need an account token.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

Headline counts

GET — Get the account's top-line counts: reviews, responses, rating, response rate.

Open →

Average rating over time

GET — Get average rating by month.

Open →

Reviews over time

GET — Get review counts by month.

Open →

Responses over time

GET — Get response counts by month.

Open →

Response time over time

GET — Get average time to respond by month.

Open →

Review requests over time

GET — Get review requests sent by month and how many produced reviews.

Open →

Rating breakdown

GET — Get counts by star rating.

Open →

Reviews by site

GET — Get the share of reviews from each site.

Open →

Sentiment

GET — Get the share of positive, neutral, and negative reviews.

Open →

This year versus last

GET — Get review volume and rating for the current year against the previous.

Open →

Top locations

GET — Get the account's best locations by rating and volume.

Open →

Monthly ranking

GET — Get locations ranked for a given month.

Open →

Twelve-month ranking

GET — Get locations ranked over the last twelve months.

Open →

Twelve-month ranking (explicit window)

GET — Get locations ranked over the last twelve months, passing an explicit range_start/range_end window.

Open →

List sub-accounts

GET — Get the accounts nested under this one, if the account has a hierarchy.

Open →


Did this page help you?