Get entity from Survey by key

Internal identifier for ChurnZero.

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

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).

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.

Whether a segment-entry send is held until the account's active hours. When false the send goes out at the moment it is triggered. Only meaningful when SendBasedOn is "Segment entry" — scheduled-time surveys always report false.

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.

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

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.

What triggers the send: "A scheduled time" (the survey fires at its configured SendTime) or "Segment entry" (the survey fires when a recipient enters the targeted Segment).

Which days the survey may send on: Business (weekdays only) or Calendar (any day).

The clock time the survey is configured to send, in the survey's SendTimeZone (e.g. 09:30:00). Null when no send hour is set. Supports $select and $filter (including the range operators); sorting is not available on this property, because it is computed from the stored hour and minute rather than held as a single column.

The time zone the survey's send time is expressed in, as an IANA time zone id (e.g. "America/New_York", "Etc/UTC"). Supports $select and $filter; filter with 'eq' and a full IANA id — the substring functions are not available, and sorting is not available on this property.

For a segment-entry survey, whether recipients already in the targeted Segment when the survey was activated are surveyed, rather than only those who enter afterwards.

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

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).