Ingestion API
Capture reviews
Push reviews collected on your site or from another tool. Secret key only.
Endpoint
POST/api/v1/reviews
Body
| Field | Type | Description |
|---|---|---|
rating | integer | Required. 1 to 5. |
review | string | Review text (max 5,000). Alias: body. |
title | string | Review title. |
reviewerName | string | Name shown on the review. Alias: name. |
source | string | e.g. website, g2, capterra, trustpilot, app_store. |
product | string | Product or plan reviewed. |
externalId | string | Your id for the review (prevents duplicates). |
reviewedAt | string | ISO date of the review. |
metadata | object | Extra data (max 8 KB). |