Sign in
latestOpenAPI 3.0.42026-08-2211752834.3 KB

fa74265a328d

SurveyResponse

Get Survey from SurveyResponse

get/SurveyResponse({Id})/Survey

Path parameters

Idnumber nullable required

Id of the SurveyResponse

Query parameters

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved navigation property

Idnumber

Internal identifier for ChurnZero.

CampaignStatusstring

The lifecycle status of the survey: Draft, Paused, Running, Complete, or Archived. Running surveys are actively sending (shown as Active in the ChurnZero UI).

CampaignTypestring

How the survey dispatches: Periodic (recurring on a schedule), OnSegmentEntry (sends when a Contact or record enters a targeted Segment), External (responses collected outside ChurnZero and synced in), or Imported (historical responses imported from another platform).

DripOverMonthsnumber

The drip rate for a Periodic survey: the number of months (1, 3, or 6) the send is spread over, surveying a portion of the target population each day instead of sending to everyone at once. 0 means the survey sends to everyone at once.

IsActiveboolean

Whether the survey is actively processing recipients. When set to false the survey pauses in place: no new recipients enter and no further sends or reminders go out until it is reactivated.

Namestring

The name of the survey, shown on the Surveys page in ChurnZero.

RecurringEveryMonthsnumber

For Periodic surveys, the recurrence interval in months: how long after a recipient's previous survey they are surveyed again (e.g. 6 = re-surveyed six months later). 0 means a one-time survey.

SegmentIdsnumber[]

The Ids of the Segments that define the survey's audience. Membership in any one of the listed Segments qualifies a recipient (OR logic).

SurveyQuestionstring

The text of the survey's primary question shown to recipients (e.g. the NPS question "How likely is it that you would recommend ... ?").

SurveyTypestring

The type of the survey: NPS (loyalty, scored 0-10), CSAT (satisfaction), CES (effort, 1-7 scale), or Custom (multi-question survey; see the SurveyQuestion entity for its questions).

Example response

{
  "FollowUpQuestions": [
    {
      "Question": "What is the primary reason for your score?",
      "AnswerType": "Text"
    }
  ],
  "Settings": {
    "ChoiceCount": 10,
    "AnswerType": "Number"
  }
}