GET responses/list

Home / REST APIs / GET responses/list

GET responses/list

Returns a collection of the questionnaire responses on the authorized user’s account.

Resource URL

https://zimovi.com/api/responses/list.json (or .xml)

Resource Information

Required scope
insights
Required role
Media manager
Response formats
JSON, XML
Requires authentication?
Yes

Parameters

since
optional
Returns results with an ID greater than (that is, more recent than) the specified ID.
until
optional
Returns results with an ID less than (that is, older than) the specified ID.
count
optional
Specifies the number of records to retrieve. Must be less than or equal to 100; defaults to 20.
questionnaire_ids
optional
Specifies a comma-separated list of the questionnaire ID(s) for the resource(s) that are being retrieved.
response_references
optional
Specifies a comma-separated list of the response reference(s) for the resource(s) that are being retrieved.
person_references
optional
Specifies a comma-separated list of the person reference(s) for the resource(s) that are being retrieved. (Custom Data Integration Guide)
video_status
optional
Supported values:

  • none : show responses include no videos
  • submitted : show responses include videos
  • processed : show responses with all clips being processed
  • produced : show responses with final video[1] being produced
  • approved : show responses with final video being approved
  • rejected : show responses with final video being rejected
[1] final video : join all video clips together into one video

Example Request

GET https://zimovi.com/api/responses/list.json?questionnaire_ids=f10b80c117803ea8,ac790aac7f051e83&since=56d1a049c621f6cde26977cc&until=56d203f5c621f6cde2697877

Example Result

{
      "responses":{
         "response":[
            {
               "id":"5644d9ccc621f6cde2687cd5",
               "questionnaire":{
                  "id":"1c67398aaa264b36",
                  "title":"Contact",
                  "page":"https:\/\/zimovi.com\/channel\/zimovi\/questionnaire\/1c67398aaa264b36",
                  "domain":"zimovi.com"
               },
               "device":{
                  "platform":"Macintosh",
                  "browser":"Firefox",
                  "version":"44.0"
               },
               "last_edit":"2016-02-28T10:22:25+00:00",
               "edit_count":5,
               "created_at":"2015-11-12T18:26:21+00:00",
               "person":{
                  "is_user":false,
                  "reference":"SAMPLE_USER_ID",
                  "name":"Alex Sample",
                  "email":"alex.sample@company.com",
                  "ip":"81.132.223.143",
                  "country":"GB",
                  "geolocation":{
                     "type":"Point",
                     "coordinates":[
                        53.3416,
                        -1.5213
                     ]
                  }
               },
               "summary":{
                  "reference":"78cc4744b38d5d33bbb587d896e1d148",
                  "title":"Alex Sample",
                  "has_video":false,
                  "scorable":true,
                  "score":25,
                  "correct":true
               },
               "questions":{
                  "question":[
                     {
                        "title":"Name",
                        "type":"single-line text",
                        "answer":"Alex Sample"
                     },
                     {
                        "title":"Contact Details",
                        "type":"multiple choice",
                        "answer":[
                           {
                              "option":"Email",
                              "description":"alex.sample@company.com",
                              "correct":true
                           },
                           {
                              "option":"Skype",
                              "description":"alex.sample",
                              "correct":true
                           }
                        ]
                     },
                     {
                        "title":"Company Size",
                        "type":"single choice",
                        "answer":[
                           {
                              "option":"50 to 100",
                              "correct":true
                           }
                        ]
                     },
                     {
                        "title":"Company Name",
                        "type":"single-line text",
                        "answer":"Zang Family"
                     },
                     {
                        "title":"Your Message",
                        "type":"multi-line text",
                        "answer":"Sample message only"
                     },
                     {
                        "title":"Are you a male or female",
                        "type":"single choice",
                        "answer":[
                           {
                              "option":"Female",
                              "correct":true
                           }
                        ]
                     }
                  ]
               }
            }
         ]
      },
      "metadata":{
         "total":1,
         "count":20,
         "since":"55c1d671c621f6cde2684a0b",
         "until":""
      }
}

Example Result (With video questions)

{
      "responses":{
         "response":[
            {
               "id":"56d2ccfbc621f6cde2697937",
               "questionnaire":{
                  "id":"f10b80c117803ea8",
                  "title":"Sample Video Questionnaire",
                  "page":"https:\/\/zimovi.com\/channel\/zimovi\/record\/f10b80c117803ea8",
                  "domain":"zimovi.com"
               },
               "device":{
                  "platform":"iPhone",
                  "browser":"Safari",
                  "version":"9.0"
               },
               "last_edit":"2016-02-28T10:33:30+00:00",
               "edit_count":0,
               "created_at":"2016-02-28T10:33:30+00:00",
               "person":{
                  "is_user":false,
                  "ip":"81.132.223.143",
                  "country":"GB",
                  "geolocation":{
                     "type":"Point",
                     "coordinates":[
                        53.3411,
                        -1.5206
                     ]
                  }
               },
               "summary":{
                  "reference":"62c3e17cea1406fee785bab6b27ba8ee",
                  "title":"Sample title",
                  "has_video":true,
                  "scorable":false,
                  "clips":{
                     "count":2,
                     "processed_at":"2016-02-28T10:36:41+00:00",
                     "page":"https:\/\/zimovi.com\/channel\/zimovi\/clip\/f10b80c117803ea8\/62c3e17cea1406fee785bab6b27ba8ee"
                  },
                  "video":{
                     "id":"8f160e44282ef9bc",
                     "title":"Sample title",
                     "description":"Sample description",
                     "duration":"00:16",
                     "created_at":"2016-02-28T10:38:02+00:00",
                     "poster":"\/\/d1teylh2i3wa1w.cloudfront.net\/videos\/62c3e17cea1406fee785bab6b27ba8ee_640.jpg",
                     "width":"480",
                     "height":"360",
                     "privacy":"3",
                     "page":"https:\/\/zimovi.com\/channel\/zimovi\/video\/8f160e44282ef9bc",
                     "player":"<iframe src=\"https:\/\/zimovi.com\/channel\/zimovi\/player\/video\/2462\" width=\"480\" height=\"360\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen><\/iframe>"
                  }
               },
               "questions":{
                  "question":[
                     {
                        "title":"Title of quesiton 1",
                        "type":"video",
                        "answer":{
                           "video":{
                              "id":"846d1d3d395c6080"
                           }
                        }
                     },
                     {
                        "title":"Title of question 2",
                        "type":"video",
                        "answer":{
                           "video":{
                              "id":"365abc6c249c2e97"
                           }
                        }
                     },
                     {
                        "title":"Title of multi-line text question",
                        "type":"multi-line text",
                        "answer":"Sample description"
                     },
                     {
                        "title":"Title of single-line text question",
                        "type":"single-line text",
                        "answer":"Sample title"
                     }
                  ]
               }
            }
         ]
      },
      "metadata":{
         "total":1,
         "count":20,
         "since":"56d2cabac621f6cde2697931",
         "until":""
      }
}
Contact Us

We're not around right now. But you can send us an email and we'll get back to you, asap.

Not readable? Change text. captcha txt