Retrieve bottom line (total reviews and average score) for all products

A request to retrieve all bottomlines (average score and review count of an account). The request is paginated and limited to a maximum of 100 items per page. Product grouping and/or syndication may result in two bottomline scores for each product:

  • The first score represents all grouped reviews and syndicated reviews
  • The second score represents the organic score

GET | https://api-cdn.yotpo.com/v1/apps/{app_key}/bottom_lines?count=5&page=5

Example requests

curl --request GET \
     --url '<https://api-cdn.yotpo.com/v1/apps/{app_key}/bottom_lines?count=5&page=5>' \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json'
http GET '<https://api-cdn.yotpo.com/v1/apps/{app_key}/bottom_lines?count=5&page=5>' \
  Content-Type:application/json \
  accept:application/json

Path params

ParamTypeDescription
app_key (required)StringThe store ID

Query params

ParamTypeDescription
count (required)int32The amount of bottom lines to return per page. Maximum 100 per page.
page (required)int32The page number of the paginated response.
since_idstringMinimum ID of the returned reviews.

👍

How to use this endpoint

  • Requests for this endpoint are limited to 5,000 requests/minute, per app key.
  • Data is retrieved with a delay of 1 hour.

Example responses

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "response": {
    "bottomlines": [
      {
        "domain_key": "1518844613",
        "product_score": 4.86,
        "total_reviews": 28
      },
      {
        "domain_key": "158482417",
        "product_score": 4.74,
        "total_reviews": 31
      },
      {
        "domain_key": "158483079",
        "product_score": 4.84,
        "total_reviews": 32
      },
      {
        "domain_key": "158486229",
        "product_score": 5,
        "total_reviews": 8
      },
      {
        "domain_key": "158489459",
        "product_score": 5,
        "total_reviews": 5
      }
    ],
    "page": "5",
    "per_page": "5"
  }
}
{}
{
	status: {
		code: 200,
		message: "OK"
	},
	response: {
		bottomlines: [{
				domain_key: "yotpo_site_reviews",
				product_score: 4.81,
				total_reviews: 278
			},
			{
				domain_key: "yotpo_site_reviews",
				product_score: 4.67,
				total_reviews: 81
			},
			{
				domain_key: "10514291267",
				product_score: 4.78,
				total_reviews: 161
			},
			{
				domain_key: "10514291267",
				product_score: 4.72,
				total_reviews: 43
			},
			{
				domain_key: "10514287427",
				product_score: 4.76,
				total_reviews: 448
			},
			{
				domain_key: "10514287427",
				product_score: 4.66,
				total_reviews: 119
			},
			{
				domain_key: "10514285763",
				product_score: 4.75,
				total_reviews: 1430
			},
			{
				domain_key: "10514285763",
				product_score: 4.63,
				total_reviews: 390
			},
			{
				domain_key: "10514290755",
				product_score: 4.82,
				total_reviews: 271
			},
			{
				domain_key: "10514290755",
				product_score: 4.75,
				total_reviews: 73
			},
			{
				domain_key: "10514291843",
				product_score: 4.82,
				total_reviews: 164
			},
			{
				domain_key: "10514291843",
				product_score: 5,
				total_reviews: 34
			},
			{
				domain_key: "10514288835",
				product_score: 4.86,
				total_reviews: 294
			},
			{
				domain_key: "10514288835",
				product_score: 4.88,
				total_reviews: 72
			},
			{
				domain_key: "1725244538926",
				product_score: 4.79,
				total_reviews: 53
			},
			{
				domain_key: "1853301456942",
				product_score: 4,
				total_reviews: 4
			},
			{
				domain_key: "1853301456942",
				product_score: 3.67,
				total_reviews: 3
			}
		],
		page: "1",
		per_page: "100"
	}
}