Review summaries.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.reviews.summary({
  organization: 0,
});

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "averageScore": "4.5",
  "numOfReviews": 100,
  "aspectScores": [
    {
      "type": "accommodation",
      "averageScore": "4.5",
      "name": "Accommodation"
    }
  ]
}

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

• organizationnumberrequired

  Organization ID

• accommodationnumberoptional
• accommodationCategorynumberoptional
• localityCategorynumberoptional

Returns

Schema shown for 200 · application/json

• averageScorenumberoptional
• numOfReviewsnumberoptional
• aspectScoresobject[]optional
  Show array — 3 properties

  • typestringoptional
  • averageScorenumberoptional
  • namestringoptional