Skip to main content
POST
/
api
/
consumeraffairs
/
brands
/
reviews
/consumeraffairs/brands/reviews
curl --request POST \
  --url https://api.anysite.io/api/consumeraffairs/brands/reviews \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "brand": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "@type": "@consumeraffairs_review",
    "author": "<string>",
    "location": "<string>",
    "rating": 123,
    "date": "<string>",
    "text": "<string>",
    "is_verified": true,
    "is_featured": true,
    "tags": [],
    "images": [],
    "reply": {
      "@type": "@consumeraffairs_review_reply",
      "author": "<string>",
      "date": "<string>",
      "text": "<string>"
    }
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
brand
string
required

ConsumerAffairs brand identifier. Accepts 'category/alias' ('solar-energy/sunrun'), 'category/alias.html', or full brand URL ('https://www.consumeraffairs.com/solar-energy/sunrun.html').

Minimum string length: 1
Pattern: ^(?:https?://[^\s]+|//[^\s]+|(?:www\.|consumeraffairs\.com)[^\s]*|/?[a-z0-9][a-z0-9-]*/[a-z0-9][a-z0-9._-]*(?:\.html)?)$
Examples:

"solar-energy/sunrun"

"solar-energy/sunrun.html"

"https://www.consumeraffairs.com/solar-energy/sunrun.html"

count
integer
required

Max number of reviews to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
@type
string
default:@consumeraffairs_review
author
string | null
location
string | null
rating
number | null
date
string | null
text
string | null
is_verified
boolean | null
tags
string[]
images
string[]
reply
ConsumeraffairsReviewReply · object