CSAT Surveys

The CSAT API lets you manage customer satisfaction surveys that are automatically sent after conversation resolution. Surveys collect 1-5 star ratings and optional text feedback.

How It Works

A conversation is resolved
After a configurable delay (default: 1-24 hours), a CSAT survey email is sent
The customer clicks a one-click rating link or opens the full survey
Results are aggregated in the analytics dashboard

List Surveys

cURL

curl "https://apps.aurionai.net/api/v1/csat/surveys?limit=10" \
  -H "X-API-Key: ak_live_xxxx"

Response:

{
  "data": [
    {
      "id": "csat_abc123",
      "conversation_id": "conv_456",
      "contact_email": "jane@example.com",
      "rating": 5,
      "feedback": "Very helpful, resolved my issue quickly!",
      "status": "completed",
      "sent_at": "2026-03-07T14:00:00Z",
      "responded_at": "2026-03-07T16:30:00Z"
    }
  ],
  "total": 85,
  "limit": 10,
  "offset": 0
}

CSAT Analytics

Get aggregated CSAT metrics and trends:

curl "https://apps.aurionai.net/api/v1/csat/analytics?start_date=2026-03-01&end_date=2026-03-08" \
  -H "X-API-Key: ak_live_xxxx"

Response:

{
  "period": {
    "start": "2026-03-01",
    "end": "2026-03-08"
  },
  "total_surveys_sent": 120,
  "total_responses": 85,
  "response_rate": 70.8,
  "average_rating": 4.3,
  "rating_distribution": {
    "1": 2,
    "2": 5,
    "3": 12,
    "4": 30,
    "5": 36
  }
}

One-Click Rating

Each survey email contains one-click rating links. When a customer clicks a rating, their response is recorded immediately:

GET https://apps.aurionai.net/api/v1/csat/rate?token=survey_token&rating=5

This is a public endpoint — no authentication required. The survey token ensures only the intended recipient can respond.

Submit Full Survey

For the full survey form with optional feedback:

curl -X POST "https://apps.aurionai.net/api/v1/csat/survey_token/submit" \
  -H "Content-Type: application/json" \
  -d '{
    "rating": 4,
    "feedback": "Good service, but took a bit long to respond."
  }'

Survey Statuses

Status	Description
`pending`	Survey scheduled but not yet sent
`sent`	Email delivered, awaiting response
`completed`	Customer submitted a rating
`expired`	Survey expired without response

Rate Limits

Endpoint	Limit
Rate (one-click)	30/minute
List surveys	30/minute
Submit response	10/minute
Analytics	30/minute

Configuration

CSAT survey settings can be managed via the API or in the admin dashboard under Configuration > CSAT.

Get CSAT Configuration

curl "https://apps.aurionai.net/api/v1/csat/config" \
  -H "X-API-Key: ak_live_xxxx"

Response:

{
  "enabled": true,
  "survey_delay_hours": 2,
  "survey_expiry_days": 7
}

Update CSAT Configuration

curl -X PUT "https://apps.aurionai.net/api/v1/csat/config" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "survey_delay_hours": 4,
    "survey_expiry_days": 14
  }'

Configurable options:

Field	Type	Description
`enabled`	boolean	Enable or disable CSAT surveys
`survey_delay_hours`	integer (1-72)	Hours after resolution before sending survey
`survey_expiry_days`	integer (1-30)	Days before the survey link expires

Analytics — CSAT analytics and trends
Conversations — Conversations that trigger CSAT surveys
Webhooks — Subscribe to csat.* events

Required Scopes

Scope	Endpoints
`csat:read`	`GET /v1/csat/surveys`, `GET /v1/csat/analytics`, `GET /v1/csat/config`
`config:write`	`PUT /v1/csat/config`

Public endpoints (GET /v1/csat/rate, POST /v1/csat/:token/submit) do not require API key authentication — they use survey tokens.

CSAT Surveys

On this page