Docs

List review changes

Preview· P9
GET
/review-changes

Returns every change to your page's reviews after a position, oldest first: published, updated (the reviewer edited it), removed (a moderator removed it, or the reviewer withdrew it) and replied. Each comes with the review as it is now; one that has left the page is a tombstone (its id and status, never its words), so your copy can drop it. Keep the last next_since and ask from it after an outage: changes are kept 13 months, longer than events. since=0 starts from the oldest kept; before that, list the reviews in full.

Scope: reviews:read · Plan: Growth, Pro and Enterprise in live mode (Reviews Business for an Agoo Reviews key); every plan in test mode.

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers 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 modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs above, on any level: it reads the business's reviews and checks every write without saving it

Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

Scope: reviews:read

Query Parameters

since?integer

The last seq you have (0: the oldest kept).

Formatint64
Range0 <= value
limit?integer

How many changes, 1 to 500.

Range1 <= value <= 500
Default100

Response Body

The changes, oldest first.

application/json
  1. response
object*"list"
Value in"list"
data*array<>
next_since*integer

Send it as since next time.

Formatint64
has_more*boolean
oldest_kept?|

Changes are kept 13 months.

Formatdate-time
curl -X GET 'https://api.agoohq.com/v1/review-changes'
{  "object": "list",  "data": [    {      "seq": 0,      "change": "published",      "changed_at": "2019-08-24T14:15:22Z",      "review_id": "string",      "review": {        "id": "review_01m6b3c4d5e6f7g8h9jkmnpqrs",        "object": "review",        "business_id": "string",        "place": {          "id": "rplace_01m6a2b3c4d5e6f7g8h9jkmnpq",          "name": "string",          "town": "string",          "site_id": "string"        },        "status": "published",        "stars": 1,        "title": "string",        "body": "string",        "visit_month": "string",        "language": "string",        "label": "verified_visit",        "proof_seen": true,        "reviewer_name": "string",        "reply": {          "body": "string",          "status": "screening",          "published_at": "2019-08-24T14:15:22Z",          "updated_at": "2019-08-24T14:15:22Z"        },        "url": "http://example.com",        "removal_reason": "string",        "published_at": "2019-08-24T14:15:22Z",        "edited_at": "2019-08-24T14:15:22Z"      }    }  ],  "next_since": 0,  "has_more": true,  "oldest_kept": "2019-08-24T14:15:22Z"}