Get CSAT configuration

GET

/api/workspaces/{workspaceId}/csat-config

• Production

Retrieve the current CSAT configuration for a workspace. These settings control how satisfaction scores are collected and how circuit breakers are triggered.

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

string format: uuid

The workspace to get CSAT configuration for.

Responses

200

The CSAT configuration.

CSAT configuration for a workspace, controlling how satisfaction scores are collected and how circuit breakers are triggered.

object

workspaceId

required

The workspace this configuration belongs to.

string format: uuid

Example

a1b2c3d4-e5f6-7890-abcd-ef1234567890

emailInlineEnabled

required

Include a satisfaction link in the resolution email.

boolean

Example

true

emailFollowupEnabled

required

Send a separate follow-up email requesting satisfaction feedback.

boolean

linkExpiryDays

required

Number of days before a satisfaction link expires.

integer

Example

14

followUpDelayMinutes

required

Minutes to wait after resolution before sending a follow-up email.

integer

Example

60

thresholdResolutionFailure

required

Composite score below which a conversation is flagged as a resolution failure.

number

Example

2

thresholdLowComposite

required

Composite score threshold for the circuit breaker counter.

number

Example

3

circuitBreakerCount

required

Number of consecutive low-scoring conversations before a circuit breaker triggers.

integer

Example

3

circuitBreakerWindowHours

required

Time window in hours for counting consecutive low scores.

integer

Example

72

baselineOutcome

Expected baseline for the outcome dimension; used to compute disconfirmation.

number | null

baselineProcess

Expected baseline for the process dimension.

number | null

baselineEnvironment

Expected baseline for the environment dimension.

number | null