Thanks to visit codestin.com
Credit goes to developer.reviewpush.com

Developer Site

REST API > User API > Reviews

Thursday, September 28, 2023 3:33 PM

Reviews Endpoint

GET https://dashboard.reviewpush.com/api/user/reviews

Options

GET Param Description
location_id Filter by a location ID (integer)
location_profile_id Filter by a location profile ID (integer)
limit Set the number of reviews per page
added_since Only return reviews added since a certain date/time
added_before Only return reviews added before a certain date/time
review_text Specify empty to return only reviews with no text, notempty to return only reviews with text, or leave blank for all reviews
metadata (array) Filter the reviews feed by metadata values (see below)

Note: In order to use added_since, you should store the refresh_date value from your last call and pass it back as the added_since value.

The metadata can consist of multiple array keys/values: ?metadata[manager]=Bob&metadata[make]=Mercedes

Includes

You can optionally include the review's location and location profile:

?include=location, ?include=profile, ?include=response, ?include=suggestedResponses, ?include=location,profile

These entites will be included in a separate "included" group following the "data" collection. The links will be specified in a "relationships" section on each data entry. See the single review response below for an example. Parser libraries may be available for your platform.

Sample Response:

{
  "data": [
    {
      "type": "reviews",
      "id": "63",
      "attributes": {
        "review": "Beatae qui quis autem eaque. Ad non et sunt sint nesciunt dolorum. Possimus est debitis ut laborum qui. Voluptas sit quas qui aut.",
        "rating": 2,
        "reviewer": "",
        "review_url": "http://review.site/123",
        "respond_url": "http://review.site/123/respond",
        "share_url": "http:\/\/go.reviewpush.com\/r\/v\/63",
        "review_date": "2015-10-21",
        "review_time": "17:56:59",
        "user_profile_image": "http:\/\/go.reviewpush.com\/img\/default-user-image.png",
        "images": [
          {
            "thumb": "http:\/\/url.to\/app\/review\/images\/64df87ce-ddee-4e31-8a15-9a7cb3d3da14_thumb.png",
            "large": "http:\/\/url.to\/app\/review\/images\/64df87ce-ddee-4e31-8a15-9a7cb3d3da14_large_watermark.png"
          }
        ],
        "publishable": false,
        "published": true,
        "response": false,
        "links": {
          "self": "https:\/\/dashboard.reviewpush.com\/api\/user\/reviews\/63"
        }
      }
    },
    {
      "type": "reviews",
      "id": "67",
      "attributes": {
        "review": "Enim omnis velit quaerat molestiae. Accusamus aut magnam aut explicabo eius autem. Molestiae sapiente itaque placeat architecto dicta at quo.",
        "rating": 3,
        "reviewer": "",
        "review_url": "https://review.site2/456",
        "respond_url": "http://review.site2/456/respond",
        "share_url": "http:\/\/go.reviewpush.com\/r\/v\/67",
        "review_date": "2015-10-20",
        "review_time": "14:03:03",
        "user_profile_image": "http:\/\/go.reviewpush.com\/img\/default-user-image.png",
        "images": [
          {
            "thumb": "http:\/\/url.to\/app\/review\/images\/64df87ce-ddee-4e31-8a15-9a7cb3d3da14_thumb.png",
            "large": "http:\/\/url.to\/app\/review\/images\/64df87ce-ddee-4e31-8a15-9a7cb3d3da14_large_watermark.png"
          }
        ],
        "publishable": true,
        "published": true,
        "response": {
          "id": 94,
          "user": "Company User",
          "response": "Sample response text.",
          "status": "Pending",
          "response_date": "2018-08-30 12:40:33"
        },
        "links": {
          "self": "https:\/\/dashboard.reviewpush.com\/api\/user\/reviews\/67"
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 139,
      "count": 2,
      "per_page": 2,
      "current_page": 1,
      "total_pages": 70,
      "links": {
        "next": "https:\/\/dashboard.reviewpush.com\/api\/user\/reviews\/?page=2"
      }
    },
    "refresh_date": "2015-10-22 20:56:42"
  }
}

The meta section will contain pagination information, including next/previous links if they are available. On the first page, the previous link will not be present, and the next link will not appear on the last page.

The meta section also includes a refresh_date, which is the system date/time of this request. It can be passed as the added_since parameter in a subsequent request to get only the reviews that have been added since this request.

Single Review

GET https://dashboard.reviewpush.com/api/user/reviews/123?include=location,profile

Sample Response

{
  "data": {
    "type": "reviews",
    "id": "63",
    "attributes": {
      "review": "Beatae qui quis autem eaque. Ad non et sunt sint nesciunt dolorum. Possimus est debitis ut laborum qui. Voluptas sit quas qui aut.",
      "rating": 2,
      "reviewer": "",
      "review_url": "http://review.site/123",
      "respond_url": "http://review.site/123/respond",
      "share_url": "http:\/\/go.reviewpush.com\/r\/v\/63",
      "review_date": "2015-10-21",
      "review_time": "17:56:59",
      "user_profile_image": "http:\/\/go.reviewpush.com\/img\/default-user-image.png",
      "images": [
        {
          "thumb": "http:\/\/url.to\/app\/review\/images\/64df87ce-ddee-4e31-8a15-9a7cb3d3da14_thumb.png",
          "large": "http:\/\/url.to\/app\/review\/images\/64df87ce-ddee-4e31-8a15-9a7cb3d3da14_large_watermark.png"
        }
      ],
      "publishable": false,
      "published": true,
      "response": {
        "id": 123,
        "user": "Company User",
        "response": "Sample response text.",
        "status": "Pending",
        "response_date": "2018-08-30 12:40:33"
      },
      "links": {
        "self": "https:\/\/dashboard.reviewpush.com\/api\/user\/reviews\/63"
      }
    },
    "relationships": {
      "location": {
        "data": {
          "type": "location",
          "id": "7"
        }
      },
      "profile": {
        "data": {
          "type": "profiles",
          "id": "14"
        }
      },
      "suggestedResponses": {
        "data": {
          "type": "suggested_responses",
          "id": "2621"
        }
      }
    }
  },
  "included": [
    {
      "type": "location",
      "id": "7",
      "attributes": {
        "name": "Sample Location",
        "unique_identifier": "6",
        "display_name": "Sample Location - 6",
        "address_1": "123 Sample St.",
        "address_2": "",
        "city": "Austin",
        "state": "TX",
        "zip": "78701",
        "phone": "9985553595",
        "email": "[email protected]",
        "latitude": 34.092,
        "longitude": -97.234,
        "aggregate": {
          "rating": 3,
          "reviews": 670
        },
        "created": "2015-10-21 16:38:14",
        "links": {
          "self": "https:\/\/dashboard.reviewpush.com\/api\/user\/locations\/7"
        }
      }
    },
    {
      "type": "profiles",
      "id": "14",
      "attributes": {
        "location_id": 7,
        "name": "",
        "url": "http:\/\/example.com\/",
        "site": {
          "name": "Facebook",
          "logo": "http:\/\/go.reviewpush.com\/img\/logos\/facebook.png",
          "icon": "http:\/\/go.reviewpush.com\/img\/icons\/sites\/icon-facebook.png"
        },
        "aggregate": {
          "rating": "5.00",
          "reviews": 216
        },
        "created": "2015-10-21 16:38:17"
      }
    },
    {
      "type": "suggested_responses",
      "id": "2621",
      "attributes": {
        "responses": [
          "Thanks for the great review. It was a pleasure serving you as a customer.",
          "This is great news! We're so happy to know that you had a good experience.",
          "We are glad you enjoyed your experience. Please visit us again soon!",
          "Hello, thanks for the positive feedback! We're always happy to hear good things from our customers."
        ]
      }
    }
  ]
}

Add/Update/Delete Review Metadata

Add

POST https://dashboard.reviewpush.com/api/user/reviews/123/metadata

Post in key/value pairs that should be added to the metadata. Only new keys will be stored; existing metadata values will not be overwritten. All HTML tags will be stripped.

Example: custom_manager=Bob&custom_make=Mercedes

Update

PUT https://dashboard.reviewpush.com/api/user/reviews/123/metadata

Key/value pairs that should be updated in the metadata. Only keys that start with custom_ will be updated; this will only update existing metadata values. No new keys will be stored. All HTML tags will be stripped.

Example: custom_manager=Bob&custom_make=Mercedes

Delete

DELETE https://dashboard.reviewpush.com/api/user/reviews/123/metadata

Key/value pairs that should be deleted in the metadata. Only keys that start with custom_ will be deleted. The value is not important; the keys/values will be deleted no matter the value. All HTML tags will be stripped.

Example: custom_manager=Bob&custom_make=Mercedes

Publish/Unpublish Review

PUT https://dashboard.reviewpush.com/api/user/reviews/123/publish

Post in a true/false value for the published key.

Example: published=true

Submit a Review Response

POST https://dashboard.reviewpush.com/api/user/reviews/123/response

Post in response text for the response key.

Example: response=This is a response from the user

Returns a single review (see Single Review GET sample response above). A response will not be created if the review already has a response. Otherwise, if response text was provided, the returned review data should include the new response data.