Core API
...
Results
Customer Feedback

Reviews

3min

Reviews Results

The Reviews Parameters are applicable when making a request with type=reviews to retrieve customer Reviews for a single product on Ebay - the product is specified using either the epid and ebay_domain parameters or the url parameter (where the url parameter contains a link to an Ebay product page). The parameters should be appended as querystring parameters to the Ebay Product Data API GET HTTP request.

Reviews are retrieved from the customer reviews page for a single product on Ebay.

Customer Reviews Page
Customer Reviews Page
ļ»æ

An example of the JSON object returned from a Reviews request is shown below:

JSON
ļ»æ

Countdown API returns the following properties for Reviews requests:

Paginating Results Ebay returns 10 reviews per page. To request more reviews issue additional requests incrementing the page parameter.

Property

Type

Description

reviews

array

An array of Review objects, containing each of the Customer Reviews shown on the Customer Reviews page. The Review object has the following properties:

  • id
  • string
  • The unique, Ebay-assigned, ID of the customer review. This can be used by your app to flag whether you have previously processed this review on a prior request.

ļ»æ

  • title
  • string
  • The title of the review.

ļ»æ

  • body
  • string
  • The body text of the review.

ļ»æ

  • rating
  • number
  • The product rating given by the reviewer, out of 5.

ļ»æ

  • helpful_votes
  • number
  • The number of helpful votes this review has received from other Ebay customers.

ļ»æ

  • unhelpful_votes
  • number
  • The number of unhelpful votes this review has received from other Ebay customers.

ļ»æ

  • verified_purchase
  • boolean
  • Whether this reviewer is an Ebay-verified purchaser of the product.

ļ»æ

  • seller_name
  • string
  • The name of the Ebay seller who sold the product this reviewer reviewed.

ļ»æ

  • attributes
  • array
  • Attributes Array The attributes array contains details of the product attributes as shown underneath the product title on the customer reviews page.
    • ļ»æ
      1. name
      2. string
      3. The name of the product attribute i.e. "Capacity".
    • ļ»æ
      1. value
      2. string
      3. The value of the product attribute i.e. "128 GB".

ļ»æ

Date Object The date object contains details about the date of the review.

  • raw
  • string
  • The raw date as retrieved from the Ebay page.

ļ»æ

  • utc
  • string
  • The date of the review, parsed from the raw date, in ISO 8601 format. If Countdown API cannot parse the raw date then this property will be null.

ļ»æ

Profile Object The profile object contains details of the profile of the reviewer.

  • name
  • string
  • The reviewer's profile name.

ļ»æ

  • link
  • string
  • A link to the reviewer's profile page on the Ebay domain.

top_favourable

object

The most helpful favourable customer review.

The properties of the top_favourable object are identical to the Review object above.

top_critical

object

The most helpful critical customer review.

The properties of the top_critical object are identical to the Review object above.

product

object

An object containing details of the product (in so far as those details are shown on the Customer Reviews page). For full product details you should issue a request with type=product to retrieve details from the product page .

  • title
  • string
  • The product name.

ļ»æ

  • link
  • string
  • The product page link.

summary

object

An object containing a summary of all reviews for the product, as shown at the top-left of the Customer Reviews page.

  • rating
  • number
  • The overall rating of the product, out of 5.

ļ»æ

  • ratings_total
  • number
  • The total number of customer ratings the product has received.

ļ»æ

  • reviews_total
  • number
  • The total number of customer reviews the product has received.

ļ»æ

  • reviews_breakdown
  • object
  • An object containing the total number of customer ratings the product has received, per star rating.

pagination

object

An object containing details of the current Reviews page and the total number of Reviews pages that are available. To paginate you should specify the page number in your request's page parameter .

  • current_page
  • number
  • The current page number.

ļ»æ

  • total_reviews
  • number
  • The total number of reviews available.

ļ»æ

  • next_page_link
  • string
  • A link to the next page of reviews. Can be used to determine whether additional reviews are available and whether a subsequent pagination request is required.
ļ»æ

Next Steps Ā Ā Ā Ā Ā Reviews Parametersļ»æ

Updated 08 Aug 2024
Did this page help you?