prism

A product's reviews across Amazon + Google Shopping + Trustpilot, folded into a cross-marketplace rating + themed pros/cons report.

Resolves a product on Amazon (ASIN) + Google Shopping (gid) + Trustpilot (when resolving by query, a judgment picks the result that is the product itself, not an accessory or reseller, and reports it in entity_resolution) and pulls each source's reviews, folded into a per-source rating summary (listed aggregate preferred over sample mean), a retailer matrix, and an LLM topic pass with per-topic rating impact (the model only assigns review ids: averages are recomputed in code). Anchor with asin/gid for precision (the gid is product.ext.gid, NOT the catalogid) or query to auto-resolve. Coverage spine = the resolved sources (<0.5 → 50% refund; none → full refund). Commerce legs take 20-60s.

get/prism/product-reviews

Request

Base URL: https://www.socialcrawl.dev/v1
URL: https://www.socialcrawl.dev/v1/prism/product-reviews
Auth: API key in header x-api-key

Query parameters

querystring

Product name to auto-resolve across marketplaces. (one of: query, asin, gid; at least one required)

asinstring

Amazon ASIN to anchor the Amazon axis directly. (one of: query, asin, gid; at least one required)

gidstring

Google product id (gid) to anchor the Google Shopping axis (NOT the catalogid). (one of: query, asin, gid; at least one required)

sourcesstring

CSV subset of amazon,google_shopping,trustpilot (default amazon,google_shopping; add trustpilot to include it).

countrystring

Marketplace country, as a location name or numeric code (look one up with GET /v1/content_analysis/locations).

depthinteger

Reviews per source (Trustpilot clamped ≤20).

competitorsstring

Optional competitor products for a comparison (validated; deeper sweep is a fast-follow).

includestring

CSV subset of topics, timeline, sellers, retailer_matrix, social_echo (default: all five). Naming a subset TRIMS which blocks are computed; an unknown member or an empty value is a 400. sellers also needs amazon to be in scope.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/product-reviews",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.