Welcome to the API documentation for the reviews endpoint. This section will guide you through how to interact with the /en/api-docs/reviews endpoint to retrieve information about reviews.

Endpoint Information

  • URL: /en/api-docs/reviews
  • Method: GET

Request Parameters

  • limit: Optional. The number of reviews to return. Default is 10.
  • page: Optional. The page number to return. Default is 1.
  • sort: Optional. The field to sort the reviews by. Default is date.

Example Request

curl -X GET "https://example.com/en/api-docs/reviews?limit=5&page=1&sort=date"

Response

The response will be a JSON object containing a list of reviews. Each review will include the following fields:

  • id: The unique identifier for the review.
  • title: The title of the review.
  • content: The content of the review.
  • date: The date the review was created.
  • rating: The rating given to the product or service.

Usage Example

[
  {
    "id": 1,
    "title": "Great Product",
    "content": "I absolutely love this product. It's been a lifesaver!",
    "date": "2023-01-01",
    "rating": 5
  },
  {
    "id": 2,
    "title": "Not What I Expected",
    "content": "The product was not what I expected. It arrived damaged.",
    "date": "2023-01-02",
    "rating": 2
  }
]

For more information on using our API, please visit our API Overview.

Image

Golden Retriever