Get a Meeting Survey
Retrieves details for a meeting survey identified by meetingId.
Request Header
hostEmail: Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return survey details of that user.
URI Parameters
Unique identifier for the meeting. Please note that only the meeting ID of a scheduled webinar is supported for this API.
Response Properties
Unique identifier for the survey.
Name for the survey.
Unique identifier for the meeting.
Description for the survey.
Whether the survey allows attendees to submit anonymously.
Questions for the survey.
Unique identifier for the question.
Details for the question.
Type for the question.
Text input.
Rating.
Check box which requires options.
Drop down list box which requires options.
Single radio button which requires options.
The lowest score of the rating question. This attribute will be ingnored, if the value of type attribute is not rating.
The lowest score label of the rating question. This attribute will be ingnored, if the value of type attribute is not rating.
The highest score of the rating question. This attribute will be ingnored, if the value of type attribute is not rating.
The highest score label of the rating question. This attribute will be ingnored, if the value of type attribute is not rating.
Options for the question. This attribute will be ingnored, if the value of type attribute is text or rating.
Unique identifier for the question option.
Value for the question option.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
{
"id": "f2d58ef6cc5848c9a0fb41e3b7aa0ed3",
"surveyName": "Webinar User Experience Survey",
"meetingId": "fe32230212b7421286a1f300572a6517",
"description": "A survey about user experience with webinars",
"allowAnonymousSubmit": false,
"questions": [
{
"id": 3388057,
"question": "First text question",
"required": true,
"type": "text"
},
{
"id": 3388062,
"question": "Second text question",
"required": true,
"type": "text"
},
{
"id": 3388067,
"question": "like rating",
"required": true,
"type": "rating",
"fromScore": 1,
"fromLabel": "Not Likely",
"toScore": 5,
"toLabel": "Very Likely"
},
{
"id": 3388072,
"question": "check box question",
"required": false,
"type": "checkbox",
"options": [
{
"id": 1,
"value": "Answer 1"
},
{
"id": 2,
"value": "Answer 2"
},
{
"id": 3,
"value": "Answer 3"
},
{
"id": 4,
"value": "Answer 4"
}
]
},
{
"id": 3388077,
"question": "dropdown list question",
"required": false,
"type": "singleDropdown",
"options": [
{
"id": 1,
"value": "Answer 1"
},
{
"id": 2,
"value": "Answer 2"
},
{
"id": 3,
"value": "Answer 3"
},
{
"id": 4,
"value": "Answer 4"
}
]
},
{
"id": 3388082,
"question": "radio button question",
"required": true,
"type": "singleRadio",
"options": [
{
"id": 1,
"value": "Answer 1"
},
{
"id": 2,
"value": "Answer 2"
},
{
"id": 3,
"value": "Answer 3"
},
{
"id": 4,
"value": "Answer 4"
}
]
}
]
}