Get review scores
Returns your page's score and each branch's, exactly as agoo.reviews shows them, with the spread of stars and of labels. A score shows from 3 reviews. What you pay never changes a score, an order or a page.
Scope: reviews:read · Plan: Growth, Pro and Enterprise in live mode; every plan in test mode.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: reviews:read
The scores.
application/json- response
object*"review_scores""review_scores"business*score*published*integerstars*Published reviews by stars, 1 to 5.
labels*Published reviews by label.
places*array<>curl -X GET 'https://api.agoo.ardent.africa/v1/review-scores'{ "object": "review_scores", "business": { "id": "string", "name": "string", "url": "http://example.com", "status": "notice" }, "score": { "score": 0, "reviews_counted": 0, "shown": true }, "published": 0, "stars": { "property1": 0, "property2": 0 }, "labels": { "property1": 0, "property2": 0 }, "places": [ { "id": "rplace_01m6a2b3c4d5e6f7g8h9jkmnpq", "name": "string", "town": "string", "status": "open", "site_id": "string", "url": "http://example.com", "score": 0, "reviews_counted": 0, "shown": true } ]}Flag a review POST
Asks a moderator at Agoo to look at a review, against one of the published reasons, with what they should look at. A flag never hides a review: a person decides, in the same queue as everyone's. One open flag per review. **Scope:** `reviews:write` · **Plan:** Growth, Pro and Enterprise in live mode; every plan in test mode.
List review invitations GET
Returns your organisation's review invitations, newest first: after visits and bookings, to customers, and after-sale links. Each one's `state` is `waiting`, `sent`, `not_sent` (with `skip_reason`), `stopped` or `cancelled`. Which invitation became which review is never shown, and contacts appear only as a masked line. **Scope:** `reviews:read` · **Plan:** Growth, Pro and Enterprise in live mode; every plan in test mode.