Get Survey Campaign
Returns detailed information about a specific survey campaign or link.
Endpoint
GET
v5/survey/{survey_id}/surveycampaign/{campaign_id}
Requires authentication
Path Parameters
Identifies the survey and campaign to retrieve.
survey_id
string
required
The ID of the survey.
campaign_id
string
required
The ID of the campaign or link to retrieve.
Query Parameters
None
Response
Returns a single campaign object.
result_ok
boolean
Whether the request succeeded.
data
object
The campaign object.
Examples
Note GET requests are cached for 60 seconds. Repeated identical requests within that window will return cached results.
Request (cURL)
curl -X GET "https://api.alchemer.com/v5/survey/123456/surveycampaign/300865?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"data": {
"id": "300865",
"invite_id": null,
"type": "SurveyCampaign",
"link_type": "link",
"subtype": "standard",
"status": "Active",
"name": "Default Link",
"uri": "www.alchemer.com/s3/1234567/survey",
"SSL": "False",
"primary_theme_options": null,
"primary_theme_content": null,
"token_variables": null,
"limit_responses": null,
"close_message": null,
"link_open_date": null,
"link_close_date": null,
"language": "Auto",
"date_created": "2017-10-02 15:41:41",
"date_modified": "2017-10-02 15:41:41"
}
}