Skip to content

API reference / RivetIT

Public

GET /csat Public

Aggregate CSAT rating summary for public embedding (e.g. a website trust badge)

Fully public: no bearer token accepted or required. Returns only the aggregate rating and anonymous 4-5 star comment snippets - never client names, contact names, or ticket subjects - so the response is safe to embed directly on a public marketing site with no further filtering by the caller. Cached for 5 minutes (Cache-Control: public, max-age=300).

Example request

curl "https://YOUR-HOST/api/v1/csat"
import requests

response = requests.get(
    "https://YOUR-HOST/api/v1/csat",
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/csat", {
  method: "GET",
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/csat");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
]);
$data = json_decode(curl_exec($ch), true);

Responses

200CSAT summary

FieldTypeDescription
average_rating number (float)
total_ratings integer
rating_breakdown object
rating_breakdown.1 integer
rating_breakdown.2 integer
rating_breakdown.3 integer
rating_breakdown.4 integer
rating_breakdown.5 integer
testimonials array of object
testimonials[].rating integer
testimonials[].comment string
testimonials[].date string (date)
Example response
json
{
    "average_rating": 4.8,
    "total_ratings": 132,
    "rating_breakdown": {
        "1": 1,
        "2": 1,
        "3": 1,
        "4": 1,
        "5": 1
    },
    "testimonials": [
        {
            "rating": 5,
            "comment": "Great information on the specs. Thank you for putting this together.",
            "date": "2026-07-31"
        }
    ]
}

405Bad request

FieldTypeDescription
error string

429Rate limit exceeded (see Retry-After header)

FieldTypeDescription
error string