Retrieve a review

GET/social/{connection_id}/review/{id}

Parameters

fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Review

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for the review
created_atstring (date-time)NoWhen the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
profile_idstringNoThe social profile (page/handle/listing) being reviewed
ratingnumberNoStar rating, typically 1-5
titlestringNoOptional review title/headline
contentstringNoThe review text
author_namestringNoDisplay name of the reviewer
author_avatar_urlstringNoProfile image URL of the reviewer
author_locationstringNoFree-text location of the reviewer
replyobjectNoThe business's reply to the review
reply.contentstringNoThe reply text from the business
reply.created_atstring (date-time)NoWhen the reply was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
reply.updated_atstring (date-time)NoWhen the reply was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
urlstringNoPublic permalink to the review

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/social/5de520f96e439b002043d8dc/review/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?