Loading ...

REST API: Get Surveys | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Polls and Surveys » REST API: Get Surveys
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get Surveys

0 
 /5
0 (0votes)

Get Surveys

GET  /api/surveys/list

Get a list of surveys. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
SpaceIDCSV Used in the request URL Comma-separated list of space IDs to get surveys for.
StartPage &startpage=x - Used in the request URL  Specifies the starting page of list to be returned.
PageLength &pagelength=x - Used in the request URL
 Specifies the number of results to be returned per page.
LogView &logView=true - Used in the request URL
 Logs the API call as an action in User Activity when set to true

Example request

GET: https://mycommunifire.com/api/surveys/list?SpaceIDCSV=339,395&startpage=1&pageLength=2&token=Xvrhr

Response JSON sample where survey JSON object is returned as ResponseData


 {
  "IsError": false,
    "ResponseMessage": "",
    "ResponseData": [
        {
            "PollID": 144,
            "Question": "Satisfaction survey",
            "SurveyTitle": "IT support satisfaction survey",
            "UserName": "Alexis",
            "IsLatest": false,
            "IsSurvey": true,
            "DateClose": "2024-07-02T20:18:26.86",
            "CreatedBy": 950,
            "Votes": 18,
            "DateCreated": "2024-07-02T20:18:26.86",
            "SpaceID": 339,
            "SpaceName": "Help Desk",
            "MediaServerID": 64,
            "SurveyImageFileName": "",
            "AllowSurveyRetake": false,
            "PollUrl": "https://mycommunifire.com/spaces/339/help-desk/
             surveys/144/it-support-satisfaction-survey",
            "UserProfileURL": "https://mycommunifire.com/people/Alexis",
            "UserDisplayName": "Alexis Fox",
            "UserAvatarFullUrl": "https://mycommunifire.com/Assets/
             Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
            "DateTimeSpan": "a day ago",
            "SurveyImageUrl": "https://mycommunifire.com/assets/Themes/
             default/images/survey-default.gif",
            "CurrentUserChoiceID": 0,
            "PollQuestions": [
                {
                    "QuestionID": 167,
                    "QuestionText": "How satisfied are you with the 
                     overall quality of IT support you receive?",
                    "PollID": 144,
                    "SortOrder": 1,
                    "InputControlType": 1,
                    "InputControlTypeInt": 1,
                    "Choices": [
                        {
                            "ChoiceID": 348,
                            "PollID": 144,
                            "QuestionID": 167,
                            "Points": 0,
                            "UserID": 0,
                            "Choice": "Very satisfied",
                            "Votes": 5,
                            "PollQuestionInputControlType": 0,
                            "SortOrder": 1,
                            "ChoiceImageFileName": "",
                            "TenantID": 0
                        },
                        {
                            "ChoiceID": 349,
                            "PollID": 144,
                            "QuestionID": 167,
                            "Points": 0,
                            "UserID": 0,
                            "Choice": "Dissatisfied",
                            "Votes": 3,
                            "PollQuestionInputControlType": 0,
                            "SortOrder": 2,
                            "ChoiceImageFileName": "",
                            "TenantID": 0
                        },
                        {
                            "ChoiceID": 350,
                            "PollID": 144,
                            "QuestionID": 167,
                            "Points": 0,
                            "UserID": 0,
                            "Choice": "Neutral",
                            "Votes": 2,
                            "PollQuestionInputControlType": 0,
                            "SortOrder": 3,
                            "ChoiceImageFileName": "",
                            "TenantID": 0
                        }
                    ],
                    "TenantID": 0
                }
            ],
            "EntityID": 0,
            "SurveyTestMode": false,
            "HasUserVotedForSurvey": false,
            "IsAnonymous": false,
            "TenantID": 0
        },
        },
        {
            "PollID": 116,
            "Question": "Mobile App User Experience Survey",
            "SurveyTitle": "Employees's satisfaction",
            "UserName": "Alexis",
            "IsLatest": false,
            "IsSurvey": true,
            "DateClose": "2024-6-13T11:18:07.33",
            "CreatedBy": 631,
            "Votes": 15,
            "DateCreated": "2024-06-10T11:18:07.33",
            "SpaceID": 339,
            "SpaceName": "UX",
            "MediaServerID": 64,
            "SurveyImageFileName": "",
            "AllowSurveyRetake": false,
            "PollUrl": "https://mycommunifire.com/spaces/395/ux/surveys/
             116/employees-s-satisfaction",
            "UserProfileURL": "https://mycommunifire.com/people/Alexis",
            "UserDisplayName": "Alexis Fox",
            "UserAvatarFullUrl": "https://mycommunifire.com/Assets/
             Uploaded-Photos/631/b836a81b-d16c-4874-a339-a87343941f.jpeg",
            "DateTimeSpan": "06/10/2024",
            "SurveyImageUrl": "https://mycommunifire.com/assets/Themes/
             default/images/survey-default.gif",
            "CurrentUserChoiceID": 0,
            "PollQuestions": [
                {
                    "QuestionID": 120,
                    "QuestionText":"How often do you use the mobile app?",
                    "PollID": 116,
                    "SortOrder": 1,
                    "InputControlType": 1,
                    "InputControlTypeInt": 1,
                    "Choices": [
                        {
                            "ChoiceID": 235,
                            "PollID": 116,
                            "QuestionID": 120,
                            "Points": 0,
                            "UserID": 0,
                            "Choice": "Multiple times a day",
                            "Votes": 15,
                            "PollQuestionInputControlType": 0,
                            "SortOrder": 1,
                            "ChoiceImageFileName": "",
                            "TenantID": 0
                        },
                        {
                            "ChoiceID": 236,
                            "PollID": 116,
                            "QuestionID": 120,
                            "Points": 0,
                            "UserID": 0,
                            "Choice": "Once per day",
                            "Votes": 2,
                            "PollQuestionInputControlType": 0,
                            "SortOrder": 2,
                            "ChoiceImageFileName": "",
                            "TenantID": 0
                        }
                    ],
                    "TenantID": 0
                }
            ],
            "EntityID": 0,
            "SurveyTestMode": false,
            "HasUserVotedForSurvey": false,
            "IsAnonymous": false,
            "TenantID": 0
    }
  ]
}


Please Note Your content type that you pass in the header of your request should be 'application/json'.

Wiki Index

Pages

Intranet Software