NPS® Incremental Exports - Recipients
See the core API Incremental Export documentation for general information on Zendesk incremental APIs, including detailed usage notes and examples.
JSON Format
Recipients are represented as JSON objects with the following properties:
Name | Type | Read-only | Mandatory | Description |
---|---|---|---|---|
created_at | string | true | false | When the recipient was created. |
delivered_at | string | true | false | When the survey was delivered to recipient. |
delivery_id | integer | true | false | Delivery recipient belongs to. |
id | integer | true | false | Automatically assigned when the recipient is created. |
survey_id | integer | true | false | The survey recipient belongs to. |
survey_name | string | true | false | The survey name. |
updated_at | string | true | false | When the recipient responded to the survey. |
user_email | string | false | true | The user's email address. |
user_id | integer | true | false | The recipient user ID. |
user_name | string | false | true | The user's name. |
Example
{
"created_at": "2013-08-29T00:00:00-07:00",
"delivered_at": "2013-08-29T00:00:30-07:00",
"delivery_id": 1,
"id": 1,
"survey_id": 1,
"survey_name": "Survey Name",
"updated_at": "2013-08-29T00:00:30-07:00",
"user_email": "[email protected]",
"user_id": 154506367,
"user_name": "Recipient Name"
}
Export Recipients
GET /api/v2/nps/incremental/recipients
Export incremental recipients.
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/recipients.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/recipients.json?start_time=1332034771",
"recipients": [
{
"created_at": "2020-08-29T00:00:00-07:00",
"delivered_at": "2020-08-29T00:00:00-07:00",
"delivery_id": 1,
"id": 1,
"survey_id": 1,
"survey_name": "Survey Name",
"updated_at": "2020-08-29T00:00:30-07:00",
"user_email": "[email protected]",
"user_id": 154506367,
"user_name": "Recipient Name"
}
]
}