Get Survey Report
Returns detailed information about a specified survey report.
Endpoint
GET
v5/survey/{survey_id}/surveyreport/{report_id}
Requires authentication
Path Parameters
survey_id
string
required
The ID of the survey the report belongs to.
report_id
string
required
The ID of the report to retrieve.
Query Parameters
None
Response
Returns a single report object.
result_ok
boolean
Whether the request succeeded.
data
object
The report object.
child attributes
id
integer
The report's numeric ID.
title
string
The report's name.
type
string
The internal report type identifier (e.g.
report_profile).created_on
string
Timestamp when the report was created.
modified_on
string
Timestamp when the report was last modified.
created_by
string
The user ID of the person who created the report.
modified_by
string
The user ID of the person who last modified the report.
last_run
string | null
Timestamp when the report was last run. Returns
null if the report has never been run.published
string
Whether the report is publicly published. Returns
"True" or "False".password_protected
string
Whether the report is password protected. Returns
"1" (protected) or "0" (not protected).filters
object
The date and response filters applied to the report.
child attributes
filter
string | null
The filter expression applied to this report, if any.
filter_map
string
Internal filter mapping string.
publish_links
string
The public URL where the report can be viewed.
scheduled
object
Scheduling information for the report.
child attributes
type
string | null
The schedule frequency type.
status
string | null
The schedule status.
next_run
string | null
Timestamp of the next scheduled run.
last_run
string | null
Timestamp of the last scheduled run.
recurring
string | null
Whether the schedule recurs.
Examples
Request (cURL)
curl -X GET "https://api.alchemer.com/v5/survey/123456/surveyreport/1234567?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"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
}
}
}