Outbound

Get aggregate Outbound survey response statistics

Returns aggregate statistics for a survey, matching the dashboard results tab. No respondent data is included.

GET

/v2/outbound/messages/{outboundMessageId}/survey_responses/stats

curl --request GET \
  --url 'https://do.featurebase.app/v2/outbound/messages/{outboundMessageId}/survey_responses/stats?start=%3Cstring%3E&end=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-09-03.pulsar'

{
  "object": "outbound_survey_response_stats",
  "pages": [
    {
      "avgRating": 4.2,
      "distribution": [
        {
          "choice": "6457e3ff70afca5d8c27dcc3",
          "count": 12
        }
      ],
      "npsScore": 35,
      "pageId": "6457e3ff70afca5d8c27dcc1",
      "responseCount": 40
    }
  ],
  "responseCount": 42
}

Query Parameters

start / end - Only count responses created inside this range (ISO 8601). Defaults to all responses

Response

responseCount - Responses in the range
pages - One entry per survey page with responseCount, avgRating (rating pages), npsScore (NPS pages, -100 to 100) and distribution (multiple-choice pages)

Rate Limiting

Survey reads share a per-organization budget with audience preview and survey responses. Exceeding it returns 429 with a Retry-After header.

Errors

400 - Invalid message ID format
404 - Survey not found, or the message is not a survey
429 - Organization read budget exceeded

Version Availability

This endpoint is only available in API version 2026-09-03.pulsar and newer.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

outboundMessageIdstringrequired

Outbound message ID

Example: 6457e3ff70afca5d8c27dccc

Query Parameters

startstring | nullquery

endstring | nullquery

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-09-03.pulsar, 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-09-03.pulsar

Response

Success

objectenum<string>required

Object type identifier

Available options: outbound_survey_response_stats

Example: outbound_survey_response_stats

pagesobject[]required

Statistics per survey page

Show child attributes

responseCountnumberrequired

Number of responses in the selected range

Example: 42

Still need help? Ask the team