social
review

List all reviews

Changed on

Returns a list of SocialReviews. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/social/{connection_id}/review

Request

  • Base URL
    https://api.unified.to
  • URL
    https://api.unified.to/social/{connection_id}/review
  • Auth
    API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

profile_idstring

The profile ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the review

created_atstring date-time

When the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

profile_idstring

The social profile (page/handle/listing) being reviewed

ratingnumber

Star rating, typically 1-5

titlestring

Optional review title/headline

contentstring

The review text

author_namestring

Display name of the reviewer

author_avatar_urlstring

Profile image URL of the reviewer

author_locationstring

Free-text location of the reviewer

urlstring

Public permalink to the review

rawobject

Raw data from integration

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status