Olery Developer Portal logo Olery Developer Portal

Method Path
GET https://agora.olery.com/v3/companies/:id/reviews/deleted

This endpoint returns deleted review ids from a company.

This allows you to replicate deletion in your database. We highly recommend reading the “Getting started” guide to get an idea on how data is collected.

Reasons for deletions

The generally try to avoid deletions but sometimes they are necessary:

There are some cases in which we do NOT delete reviews, even though they might no longer appear:

Filtering

Using the since parameter will return the data since the given date or time. When no since is specified the default of 1 week is used.

Frequency

We suggest to check for deleted reviews right before making the request to the Review Feed endpoint in order to import new reviews.

Example Request

https://agora.olery.com/v3/companies/123/reviews/deleted?auth_token=123456&since=2019-06-01T18:18:04

Output Format

The aggregated data is returned as a JSON array in the data field.

Field Data Types Description
meta Hash Company and other metadata
data Hash List of reviews
data[].id Integer ID of the deleted review
data[].source String Source of the deleted review
data[].connection_id Integer Connection id of the deleted review
data[].id_on_review_site String ID present on review site
data[].generated_id String Generated hash of review’s content
data[].deleted_at Time Time of deletion

Example Output

{
  "meta": {
    "company": {
      "id": 38,
      "name": "Hotel Casa"
    }
  },
  "data": [
    {
      "id": 5612133,
      "source": "trip_advisor",
      "connection_id": 707461,
      "id_on_review_site": "160057521",
      "generated_id": "009d420ac6621951ac9a68e05a7c1e0a",
      "deleted_at": "2019-04-19T01:34:17.309+00:00"
    },
    {
      "id": 508896532,
      "source": "booking_com",
      "connection_id": 113,
      "id_on_review_site": "1c81b05b6ae1011e",
      "generated_id": "bee409bd45d73806844cd829394214f954064abc",
      "deleted_at": "2019-04-29T09:15:59.065+00:00"
    }
  ]
}

Parameters

Parameter Parameter Type Data Types Required Description
id path Integer true The ID of the company.
since query Time false The start date or time in ISO 8601 format.

Response Statuses

Status Code Reason
200 OK
404 The specified company was not found.
403 Client does not have access to the company.