Survey

Get entities from Survey

Changed on
get/Survey

Request

  • Base URL: https://marketingpony.us1app.churnzero.net/public/v1
  • URL: https://marketingpony.us1app.churnzero.net/public/v1/Survey
  • Auth: HTTP basic

Query parameters

$topnumber

Show only the first n items

$skipnumber

Skip the first n items

$filterstring[]

Filter items by property values. Supports the comparison operators eq, ne, gt, ge, lt, le, in, combined with and / or — which may be mixed and grouped with parentheses (nested up to 3 levels) to control precedence — plus the string functions startswith(Property, 'value'), endswith(Property, 'value'), and contains(Property, 'value') (all case-insensitive, minimum 2 characters).

Examples:

  • $filter=startswith(Name, 'Acme') — Name begins with Acme
  • $filter=contains(Name, 'corp') — Name contains corp
  • $filter=startswith(Name, 'A') and IsActive eq true — combine with comparison operators
  • $filter=BillingAddressState eq 'VA' or (IsActive eq true and TotalContractAmount gt 10000) — mix and/or with a parenthesised group
$countboolean

Include count of items

$orderbystring[]

Order items by property values

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

$applystring

Aggregate transform. See options for groupby keys and time-bucket sources available on this entity.

Parameters

#/components/parameters/search (unresolved $ref)

Response

Retrieved entities

@odata.nextLinkstring

Example response

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

Changes

  • 02fa2d67b413Revision changes
    • info

      added the enum value FollowActiveHours to the property items/ of the query request parameter $filter

    • info

      added the enum value FollowActiveHours to the property items/ of the query request parameter $select

    • info

      added the enum value SendBasedOn to the property items/ of the query request parameter $filter

    • info

      added the enum value SendBasedOn to the property items/ of the query request parameter $select

    • info

      added the enum value SendDayType to the property items/ of the query request parameter $filter

    • info

      added the enum value SendDayType to the property items/ of the query request parameter $select

    • info

      added the enum value SendTime to the property items/ of the query request parameter $filter

    • info

      added the enum value SendTime to the property items/ of the query request parameter $select

    • info

      added the enum value SendTimeZone to the property items/ of the query request parameter $filter

    • info

      added the enum value SendTimeZone to the property items/ of the query request parameter $select

    • info

      added the enum value SendToExistingSegmentMembers to the property items/ of the query request parameter $filter

    • info

      added the enum value SendToExistingSegmentMembers to the property items/ of the query request parameter $select

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status