NPS® Incremental Exports - Responses

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

JSON Format

Responses are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
comment string false false The comment for the response.
delivered_at string true false When the delivery response was sent.
delivery_id integer true false The response delivery ID.
id integer true false Automatically assigned when response created.
rated_at string true false When the user submitted their response.
rating integer false true The user rating for the response.
recipient_id integer true false The recipient ID.
survey_id integer true false The survey response ID.
survey_name string true false The survey name.
user_email string false false The user's email address.
user_id integer true false The ID of the user who responded.
user_name string true false The user's name.
Example
{
  "comment": "It has improved the efficiency of our support department.",
  "delivered_at": "2013-08-29T00:00:00-07:00",
  "delivery_id": 1,
  "id": 1,
  "rated_at": "2013-08-29T00:00:00-07:00",
  "rating": 9,
  "recipient_id": 360121416853,
  "survey_id": 1,
  "survey_name": "Survey Name",
  "user_email": "[email protected]",
  "user_id": 154506367,
  "user_name": "Responder Name"
}

Export Responses

  • GET /api/v2/nps/incremental/responses

Export incremental responses.

Allowed for
  • Admins
Parameters
Name Type In Required Description
start_time integer Path true Timestamp of oldest entity to include in export.
Using curl
curl https://{subdomain}.zendesk.com/api/v2/nps/incremental/responses.json?start_time={start_time} \
  -v -u {email_address}:{password}
Example Response
Status 200 OK

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