Meetings - List Meeting Survey Results

List Meeting Survey Results

Retrieves results for a meeting survey identified by meetingId.

Request Header

timezone: Time zone for time stamps in response body, defined in conformance with the IANA time zone database. The default value is UTC if not specified.
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 the survey results of that user.

GET/v1/meetings/{meetingId}/surveyResults

URI Parameters

meetingId

stringrequired

Unique identifier for the meeting. Please note that only the meeting ID of a scheduled webinar is supported for this API.

Query Parameters

meetingStartTimeFrom

string

Start date and time (inclusive) in any ISO 8601 compliant format for the meeting objects being requested. meetingStartTimeFrom cannot be after meetingStartTimeTo. This parameter will be ignored if meetingId is the unique identifier for the specific meeting instance. When meetingId is not the unique identifier for the specific meeting instance, the meetingStartTimeFrom, if not specified, equals meetingStartTimeTo minus 1 month; if meetingStartTimeTo is also not specified, the default value for meetingStartTimeFrom is 1 month before the current date and time.

meetingStartTimeTo

String

End date and time (exclusive) in any ISO 8601 compliant format for the meeting objects being requested. meetingStartTimeTo cannot be prior to meetingStartTimeFrom. This parameter will be ignored if meetingId is the unique identifier for the specific meeting instance. When meetingId is not the unique identifier for the specific meeting instance, if meetingStartTimeFrom is also not specified, the default value for meetingStartTimeTo is the current date and time;For example,if meetingStartTimeFrom is a month ago, the default value for meetingStartTimeTo is 1 month after meetingStartTimeFrom.Otherwise it is the current date and time.

max

number

Limit the maximum number of meetings in the response, up to 100.

Default: 10

Response Properties

items

array[SurveyResultObject]

SurveyResult array

string

Unique identifier for the survey result.

surveyName

string

Name for the survey.

meetingId

string

Unique identifier for the meeting.

string

Email address of the user who submits the survey.

displayName

string

Name of the user who submits the survey.

createTime

string

The time when the user submits the survey.

questions

array[QuestionWithAnswersObject]

User's answers for the questions

number

Unique identifier for the question.

question

string

Details for the question.

type

enum

Type for the question.

text

string

Text input.

rating

string

Rating.

checkbox

string

Check box which requires options.

singleDropdown

string

Drop down list box which requires options.

singleRadio

string

Single radio button which requires options.

answers

array[QuestionAnswerObject]

The user's answers for the question.

optionId

number

Unique identifier for the question option. This attribute will be ingnored, if the value of type attribute is text or rating.

answer

string

The user's answers for the question.

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.

GET

/v1/meetings//surveyResults{?meetingStartTimeFrom,meetingStartTimeTo,max}

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.
timezone
hostEmail

Query Parameters

meetingStartTimeFrom
string
Start date and time (inclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested. `meetingStartTimeFrom` cannot be after `meetingStartTimeTo`. This parameter will be ignored if `meetingId` is the unique identifier for the specific meeting instance. When `meetingId` is not the unique identifier for the specific meeting instance, the `meetingStartTimeFrom`, if not specified, equals `meetingStartTimeTo` minus `1` month; if `meetingStartTimeTo` is also not specified, the default value for `meetingStartTimeFrom` is `1` month before the current date and time.
meetingStartTimeTo
String
End date and time (exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested. `meetingStartTimeTo` cannot be prior to `meetingStartTimeFrom`. This parameter will be ignored if `meetingId` is the unique identifier for the specific meeting instance. When `meetingId` is not the unique identifier for the specific meeting instance, if `meetingStartTimeFrom` is also not specified, the default value for `meetingStartTimeTo` is the current date and time;For example,if `meetingStartTimeFrom` is a month ago, the default value for `meetingStartTimeTo` is `1` month after `meetingStartTimeFrom`.Otherwise it is the current date and time.
max
number
Limit the maximum number of meetings in the response, up to 100.

https://webexapis.com/v1/meetings/560d7b784f5143e3be2fc3064a5c4999/surveyResults?meetingStartTimeFrom=2019-03-18T09:30:00Z&meetingStartTimeTo=2019-03-25T09:30:00Z&max=100

200 / OK

{
    "items": [
        {
            "id": "01c98ac1-e741-4bc1-b92b-6eb42f66caea",
            "surveyName": "Webinar User Experience Survey",
            "email": "kingu1@example.com",
            "displayName": "kingu1",
            "createTime": "2022-07-06T14:13:06Z",
            "questions": [
                {
                    "id": 3388057,
                    "question": "First text question",
                    "type": "text",
                    "answers": [
                        {
                            "answer": "yes"
                        }
                    ]
                },
                {
                    "id": 3388062,
                    "question": "Second text question",
                    "type": "text",
                    "answers": [
                        {
                            "answer": "no"
                        }
                    ]
                },
                {
                    "id": 3388067,
                    "question": "like rating",
                    "type": "rating",
                    "answers": [
                        {
                            "answer": "4"
                        }
                    ]
                },
                {
                    "id": 3388072,
                    "question": "check box question",
                    "type": "checkbox",
                    "answers": [
                        {
                            "optionId": 2,
                            "answer": "Answer 2"
                        },
                        {
                            "optionId": 3,
                            "answer": "Answer 3"
                        },
                        {
                            "optionId": 4,
                            "answer": "Answer 4"
                        }
                    ]
                },
                {
                    "id": 3388077,
                    "question": "dropdown list question",
                    "type": "singleDropdown",
                    "answers": [
                        {
                            "optionId": 2,
                            "answer": "Answer 2"
                        }
                    ]
                },
                {
                    "id": 3388082,
                    "question": "radio button question",
                    "type": "singleRadio",
                    "answers": [
                        {
                            "optionId": 3,
                            "answer": "Answer 3"
                        }
                    ]
                }
            ]
        }
    ]
}