List Survey Reports
Returns a list of all reports for the specified survey. Only the following report types are returned: Summary, TURF, and Profile. Standard (crosstab) reports are also included in the response.
Endpoint
GET
v5/survey/{survey_id}/surveyreport
Requires authentication
Path Parameters
survey_id
string
required
The ID of the survey whose reports will be listed.
Query Parameters
types
string
Filter results by report type. Accepted values:
summary, profile, turf. Pass as a comma-separated list to include multiple types.Response
Returns an array of report objects for the survey.
result_ok
boolean
Whether the request succeeded.
total_count
integer
Total number of reports returned.
results_per_page
integer
Number of results returned per page.
data
array
Array of report objects.
child attributes
id
string
The report's unique ID. Standard reports use an
st_ prefix.survey_id
string
The ID of the survey the report belongs to. Returned as
surveyID for standard report types.name
string
The report's name.
type
string
The report type. Possible values include
profile, summary, turf, standard.status
string
The report's current status (e.g.
Active).last_run
string
The date and time the report was last run. Returns
N/A if the report has never been run. Not present on standard report types.responses
integer
The number of responses included in the report. Not present on standard report types.
version
string
The report version. Not present on standard report types.
publish_link
string
The public URL where the report can be viewed.
Examples
Request (cURL)
curl -X GET "https://api.alchemer.com/v5/survey/123456/surveyreport?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"total_count": 3,
"results_per_page": 3,
"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"
}
]
}