The following API calls are currently available for the SurveyReport object. The SurveyReport object only accesses the following report types: Summary, TURF and Profile.
GET LIST - Get a list of all of your survey reports.
https://api.alchemer.com/v5/survey/123456/surveyreport
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| types | summary, profile, turf | False |
Response Example (.json format):
{
"result_ok": true,
"total_count": 1,
"results_per_page": 1,
"data": [
{
"id": "1234567",
"survey_id": "1234567",
"name": "Profile Report - Q1",
"type": "profile",
"status": "Active",
"last_run": "N/A",
"responses": 0,
"version": "3",
"publish_link": "https://app.alchemer.com/reportsview/?key=12345"
},
{
"id": "st_12345",
"surveyID": "1234567",
"name": "Q1 - Customer Feedback Crosstab",
"type": "standard",
"status": "Active",
"publish_link": "https://reporting.alchemer.com/r/12345"
},
{
"id": "st_12345",
"surveyID": "1234567",
"name": "Q1 Customer Feedback",
"type": "standard",
"status": "Active",
"publish_link": "https://reporting.alchemer.com/r/12345"
}
]
}
GET SURVEYREPORT - Get information about a specified survey report.
https://api.alchemer.com/v5/survey/123456/surveyreport/1234567
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
Response Example (.json format):
{
"result_ok": true,
"data": {
"id": 1234567,
"title": "Profile Report - Q1",
"type": "report_profile",
"created_on": "2018-03-28 12:56:04",
"modified_on": "2018-03-28 13:02:14",
"created_by": "12345",
"modified_by": "12345",
"last_run": null,
"published": "False",
"password_protected": "0",
"filters": {
"filter": null,
"filter_map": ":5abbca8e95f9e,5abbca8e96048"
},
"publish_links": "https://app.alchemer.com/reportsview/?key=12345",
"scheduled": {
"type": null,
"status": null,
"next_run": null,
"last_run": null,
"recurring": null
}
}
}
UPDATE SURVEYREPORT - Copy and update a specified survey report. At this time you can only copy a report and then filter your report. You cannot add filters to an existing report via a post. The _run parameter will perform the initial run of the copied report.
https://api.alchemer.com/v5/survey/123456/surveyreport/3?_method=POST
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| copy | true | True |
| _run* | true | False |
| filter_dates[after]* | 5/1/2014 | False |
| filter_dates[before]* | 6/1/2014 | False |
*v4 API only
Response Example (.json format):
{
"result_ok": true,
"data": {
"id": 1234567,
"title": "Profile Report - Q1",
"type": "report_profile",
"created_on": "2018-03-28 12:56:04",
"modified_on": "2018-03-28 13:02:14",
"created_by": "123456",
"modified_by": "123456",
"last_run": null,
"published": "False",
"password_protected": "0",
"filters": {
"filter": null,
"filter_map": ":5abbca8e95f9e,5abbca8e96048"
},
"publish_links": "https://app.alchemer.com/reportsview/?key=12345",
"scheduled": {
"type": null,
"status": null,
"next_run": null,
"last_run": null,
"recurring": null
}
}
}
DELETE SURVEYREPORT - Delete a specified survey report.
https://api.alchemer.com/v5/survey/123456/surveyreport/1234567?_method=DELETE
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |