API ReferenceSurveys
Surveys
CSAT ratings and post-chat surveys
CSAT ratings and post-chat surveys
Endpoints
DELETEDelete a survey — Soft-deletes a survey response by setting isActive to false; the record remains stored. Repeating the request succeeds while the record still exists.GETGet CSAT analytics — Returns CSAT summary metrics for the current organization over the selected period.GETGet CSAT statistics for an operator — Returns the average rating, total rating count, and 1-to-3 rating distribution for an operator in the authenticated organization.GETGet localized CSAT configuration — Returns the CSAT survey configuration for the selected project. A project selection is required.GETList CSAT responses with filtering — Lists CSAT responses for the current organization, sorted newest first. Use optional filters for rating, operatorId, and createdAt range.GETList surveys with filtering — Lists survey responses for the authenticated organization, newest first, using offset pagination. limit defaults to 20 and offset to 0.PATCHUpdate a survey — Corrects an existing survey response in the authenticated organization.PUTUpdate CSAT configuration — Updates CSAT survey settings for the organization. Admin access is required.
Was this page helpful?