Skip to main content
GET
Get customer satisfaction report
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:
application/json

Query Parameters

range_type
enum<string>

Pass custom_duration (or omit range_type while passing start_date/end_date) to report on an explicit range instead. When range_type, start_date and end_date are all omitted, the range defaults to all_time.

Available options:
last_7_days,
last_30_days,
last_24_hours,
this_month,
last_month,
this_year,
last_year,
this_quarter,
last_quarter,
this_week,
last_week,
all_time,
custom_duration
Example:

"last_7_days"

start_date
string<date>

Start of the date range to report on, as a YYYY-MM-DD date. Only used when range_type is custom_duration or omitted; ignored when range_type names a predefined range. Defaults to the workspace's creation date when omitted.

Example:

"2026-10-01"

end_date
string<date>

End of the date range to report on, as a YYYY-MM-DD date. Only used when range_type is custom_duration or omitted; ignored when range_type names a predefined range. Defaults to today when omitted.

Example:

"2026-10-17"

Response

OK - Request succeeded. csat_report is null when no rating question is configured.

csat_report
object | null

Customer satisfaction data for the date range. null when the workspace has no rating question configured in its post-chat survey.