NPS® Incremental Exports

See the Core API Incremental Export documentation for general information on Zendesk incremental APIs, including detailed usage notes and examples.

JSON Format for Recipients

Recipients are represented as JSON objects with the following keys:

Name Type Read-Only Mandatory Comment
id integer yes no Automatically assigned when the recipient is created
survey_id integer yes no The survey the recipient belongs to
delivery_id integer yes no The delivery the recipient belongs to
user_id integer yes no The recipient user
created_at date yes no When this recipient was created
updated_at date yes no When the recipient was last updated (i.e., by responding to the survey)
delivered_at date yes no When the survey was delivered to the recipient
user_email string no yes The email of the user
user_name string no yes The name of the user
survey_name string yes no The name of the survey
Example
{
  "id":           1,
  "survey_id":    1,
  "delivery_id":  1,
  "user_id":      154506367,
  "created_at":   "2013-08-29T00:00:00-07:00",
  "updated_at":   "2013-08-29T00:00:30-07:00",
  "delivered_at": "2013-08-29T00:00:30-07:00",
  "user_email":   "[email protected]",
  "user_name":    "Recipient Name",
  "survey_name":  "Survey Name"
}

Export Incremental Recipients

GET /api/v2/nps/incremental/recipients.json

Allowed For
  • Admins
Request Parameters
  • start_time: The time of the oldest recipient you are interested in. Returns recipients modified on or since this time.
Using curl
curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com \
  /api/v2/nps/incremental/recipients.json?start_time=1332034771
Example Response
Status: 200 OK

{
  "recipients": [
    {
      "id":          1,
      "survey_id":   1,
      "delivery_id": 1,
      "user_id":     154506367,
      "created_at":  "2013-08-29T00:00:00-07:00",
      "updated_at":  "2013-08-29T00:00:30-07:00",
      "user_email":  "[email protected]",
      "user_name":   "Recipient Name",
      "survey_name": "Survey Name"
    },
    ...
  ],
  "next_page": "https://domain.zendesk.com/api/v2/nps/incremental/recipients.json?start_time=1332034771",
  "end_time":  1332034771,
  "count":     23
}

JSON Format for Responses

Responses are represented as JSON objects which have the following keys:

Name Type Read-Only Mandatory Comment
id integer yes no Automatically assigned when the response is created
survey_id integer yes no The survey the response belongs to
delivery_id integer yes no The delivery the response belongs to
recipient_id integer yes yes The recipient the response belongs to
user_id integer yes no The user who responded
rating integer no yes The rating
comment string no no The comment
delivered_at date yes no When the delivery the response belongs to was delivered
rated_at date yes no When the user submitted the response
user_email string yes no The email of the user
user_name string yes no The name of the user
survey_name string yes no The name of the survey
Example
{
  "id":           1,
  "survey_id":    1
  "delivery_id":  1,
  "user_id":      154506367,
  "rating":       9,
  "comment":      "It has improved the efficiency of our support department.",
  "delivered_at": "2013-08-29T00:00:00-07:00",
  "rated_at":     "2013-08-29T00:00:00-07:00",
  "user_email":   "[email protected]",
  "user_name":    "Responder Name",
  "survey_name":  "Survey Name"
}

Export Incremental Responses

GET /api/v2/nps/incremental/responses.json

Allowed For
  • Admins
Request Parameters
  • start_time: The time of the oldest response you are interested in. Returns responses modified on or since this time.
Using curl
curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com \
  /api/v2/nps/incremental/responses.json?start_time=1332034771
Example Response
Status: 200 OK

{
  "responses": [
    {
      "id":           1,
      "survey_id":    1,
      "delivery_id":  1,
      "user_id":      154506367,
      "rating":       9,
      "comment":      "It has improved the efficiency of our support department.",
      "delivered_at": "2013-08-29T00:00:00-07:00",
      "rated_at":     "2013-08-29T00:00:00-07:00",
      "user_email":   "[email protected]",
      "user_name":    "Responder Name",
      "survey_name":  "Survey Name"
    },
    ...
  ],
  "next_page": "https://subdomain.zendesk.com/api/v2/nps/incremental/responses.json?start_time=1332034771",
  "end_time":  1332034771,
  "count":     23
}