customerSurvey

QUERY

customerSurvey(id: ID!): CustomerSurvey

Arguments

ID!

required

Returns

CustomerSurvey

ID!

name

String!

template

CustomerSurveyTemplate!

The survey template that defines the type and question text sent to the customer (e.g. a CSAT template).

conditions

[CustomerSurveyCondition!]!

Targeting conditions that restrict which threads this survey is sent on. When empty, the survey applies to all threads.

conditionsOperator

CustomerSurveyConditionsOperator!

How individual conditions are combined. AND requires every condition to match; OR requires at least one.

isEnabled

Boolean!

Whether the survey is active and will be sent to customers. Disabled surveys are never triggered.

responseDelayMinutes

Int!

How many minutes after a thread is resolved before the survey is sent to the customer.

customerIntervalDays

Int!

Minimum number of days that must pass before the same customer can be sent this survey again.

order

Int!

Zero-based integer controlling the display and evaluation order of surveys relative to one another.

createdAt

createdBy

updatedAt

updatedBy

Query

query CustomerSurvey($id: ID!) {
  customerSurvey(id: $id) {
    id
    name
    template {
      __typename
      ... on CsatCustomerSurveyTemplate {
        type
        questionText
      }
    }
    conditions {
      __typename
      ... on CustomerSurveyTiersCondition {
        tierIds
        operator
      }
    }
    conditionsOperator
    isEnabled
  }
}

Variables

{
  "id": "id"
}

Response

{
  "data": {
    "customerSurvey": {
      "id": "id",
      "name": "string",
      "template": {
        "__typename": "CsatCustomerSurveyTemplate",
        "type": "string",
        "questionText": "string"
      },
      "conditions": [
        {
          "__typename": "CustomerSurveyTiersCondition",
          "tierIds": [
            "id"
          ],
          "operator": "INCLUDES"
        }
      ],
      "conditionsOperator": "AND",
      "isEnabled": true
    }
  }
}

⌘I

Query

query CustomerSurvey($id: ID!) {
  customerSurvey(id: $id) {
    id
    name
    template {
      __typename
      ... on CsatCustomerSurveyTemplate {
        type
        questionText
      }
    }
    conditions {
      __typename
      ... on CustomerSurveyTiersCondition {
        tierIds
        operator
      }
    }
    conditionsOperator
    isEnabled
  }
}

Variables

{
  "id": "id"
}

Response

{
  "data": {
    "customerSurvey": {
      "id": "id",
      "name": "string",
      "template": {
        "__typename": "CsatCustomerSurveyTemplate",
        "type": "string",
        "questionText": "string"
      },
      "conditions": [
        {
          "__typename": "CustomerSurveyTiersCondition",
          "tierIds": [
            "id"
          ],
          "operator": "INCLUDES"
        }
      ],
      "conditionsOperator": "AND",
      "isEnabled": true
    }
  }
}

Queries

Mutations

Types

Arguments

Returns