{"swagger":"2.0","info":{"title":"medallia-api","description":"API for Medallia Surveys system","contact":{"name":"Eduardo Diaz Sancha","email":"edsancha@gmail.com"},"version":"0.0.1"},"host":"api-us.kampyle.com","basePath":"/api/v1","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/accessToken":{"post":{"description":"This API is used to retrieve the temporary access token that allows your app to access all other APIs","parameters":[],"responses":{"200":{"description":"Access Token to access Medallia API","schema":{"$ref":"#/definitions/access_token_wrapper"},"headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}},"401":{"description":"Unauthorized request","headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}},"500":{"description":"All other errors.","headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}}}}},"/configuration":{"get":{"description":"This API returns the full configuration as defined in the Medallia Digital command center. It returns the list of surveys, their content and business logic as well as targeting and segmentation rules.","parameters":[],"responses":{"200":{"description":"Configuration and forms","schema":{"$ref":"#/definitions/configuration"},"headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}},"400":{"description":"The body or any of the parameters are invalid/malformed.","headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}},"401":{"description":"Unauthorized request","headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}},"500":{"description":"All other errors.","headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}}}}},"/feedback":{"post":{"description":"This API allows the application to submit feedback collected in the app to the Medallia Digital","parameters":[{"name":"feedback","in":"body","schema":{"$ref":"#/definitions/feedback"}}],"responses":{"200":{"description":"200 response","headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}},"400":{"description":"The body or any of the parameters are invalid/malformed.","headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}},"401":{"description":"Unauthorized request","headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}},"500":{"description":"All other errors.","headers":{"Authentication":{"description":"Authentication header, it can be a request Token or an access Token","type":"string"}}}}}}},"definitions":{"access_token_wrapper":{"type":"object","description":"JWT Access Token to be used to access the APIe","title":"access_token_wrapper","required":["accessToken"],"properties":{"accessToken":{"description":"JWT Access Token to be used to access the API","type":"string"}}},"component_checkbox":{"type":"object","title":"component_checkbox","required":["index","id","unique_name","required","label","options"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"required":{"description":"Component required","type":"boolean"},"label":{"description":"Component label","type":"string"},"options":{"description":"Maximum number of characters","type":"array","items":{"type":"string"}},"description":{"description":"Component description","type":"string"}}},"component_dropdown":{"type":"object","title":"component_dropdown","required":["index","id","unique_name","required","placeholder","label","options"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"required":{"description":"Component required","type":"boolean"},"placeholder":{"description":"Component placeholder","type":"string"},"label":{"description":"Component label","type":"string"},"options":{"description":"Maximum number of characters","type":"array","items":{"type":"string"}},"description":{"description":"Component description","type":"string"}}},"component_grading":{"type":"object","title":"component_grading","required":["index","id","unique_name","required","label","ratingViewType"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"required":{"description":"Component required","type":"boolean"},"label":{"description":"Component label","type":"string"},"ratingViewType":{"type":"string","enum":["slide","numbersSquare","gradingSlider","gradingDropdown","stars","emoticons","numbers","smilies","bars"]},"description":{"description":"Component description","type":"string"}}},"component_grading0to10":{"type":"object","title":"component_grading0to10","required":["index","id","unique_name","required","label","ratingViewType"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"required":{"description":"Component required","type":"boolean"},"label":{"description":"Component label","type":"string"},"ratingViewType":{"type":"string","enum":["slide","numbersSquare","gradingSlider","gradingDropdown","stars","emoticons","numbers","smilies","bars"]},"description":{"description":"Component description","type":"string"}}},"component_grading1to10":{"type":"object","title":"component_grading1to10","required":["index","id","unique_name","required","label","ratingViewType"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"required":{"description":"Component required","type":"boolean"},"label":{"description":"Component label","type":"string"},"ratingViewType":{"type":"string","enum":["slide","numbersSquare","gradingSlider","gradingDropdown","stars","emoticons","numbers","smilies","bars"]},"description":{"description":"Component description","type":"string"}}},"component_image":{"type":"object","title":"component_image","required":["index","id","unique_name"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"imageObject":{"$ref":"#/definitions/image"},"uploadedResource":{"$ref":"#/definitions/image"}}},"component_label":{"type":"object","title":"component_label","required":["index","id","unique_name","num_of_lines"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"labelContent":{"description":"Label Content","type":"string"},"num_of_lines":{"description":"Label Number of Lines","default":"2","type":"integer","format":"int32"}}},"component_nps":{"type":"object","title":"component_nps","required":["index","id","unique_name","required","label","ratingViewType"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"required":{"description":"Component required","type":"boolean"},"label":{"description":"Component placeholder","type":"string"},"description":{"description":"Component description","type":"string"},"ratingViewType":{"type":"string","enum":["slide","numbersSquare","gradingSlider","gradingDropdown","stars","emoticons","numbers","smilies","bars"]}}},"component_radioSelector":{"type":"object","title":"component_radioSelector","required":["index","id","unique_name","required","label","options"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"required":{"description":"Component required","type":"boolean"},"label":{"description":"Component label","type":"string"},"options":{"description":"Maximum number of characters","type":"array","items":{"type":"string"}},"description":{"description":"Component description","type":"string"}}},"component_textArea":{"type":"object","title":"component_textArea","required":["index","id","unique_name","required","placeholder","label","num_of_lines"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"required":{"description":"Component required","type":"boolean"},"placeholder":{"description":"Component placeholder","type":"string"},"label":{"description":"Component placeholder","type":"string"},"num_of_lines":{"description":"Number of lines, string parameter though (－‸ლ)","default":"2","type":"integer","format":"int32"},"description":{"description":"Component description","type":"string"}}},"component_textInput":{"type":"object","title":"component_textInput","required":["index","id","unique_name","required","placeholder","label","max_chars"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"required":{"description":"Component required","type":"boolean"},"placeholder":{"description":"Component placeholder","type":"string"},"label":{"description":"Component label","type":"string"},"max_chars":{"description":"Maximum number of characters","default":"200","type":"integer","format":"int32"},"description":{"description":"Component description","type":"string"}}},"configuration":{"type":"object","description":"Configuration main object, including forms","title":"configuration","required":["propertyId","feedbackSubmitUrl","forms"],"properties":{"propertyId":{"description":"Account id","type":"integer","format":"int32"},"feedbackSubmitUrl":{"description":"url","type":"string"},"forms":{"type":"array","items":{"$ref":"#/definitions/form"}}}},"dynamicData":{"type":"object","title":"dynamicData","required":["index","id","required","component","unique_name","placeholder","label"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"required":{"description":"Component required","type":"boolean"},"component":{"description":"Component type","type":"string"},"unique_name":{"description":"Component unique name","type":"string"},"placeholder":{"description":"Component placeholder","type":"string"},"label":{"description":"Component placeholder","type":"string"},"description":{"description":"Component description","type":"string"},"options":{"description":"Options available if required","type":"array","items":{"type":"string"}},"imageObject":{"$ref":"#/definitions/image"}}},"feedback":{"type":"object","description":"Feedback main object with survey's results","title":"feedback","required":["formId","dynamicData"],"properties":{"formId":{"description":"The submitted form id (from the configuration).","type":"integer","format":"int32"},"dynamicData":{"$ref":"#/definitions/feedback_data"}}},"feedback_checkbox":{"type":"object","title":"feedback_checkbox","required":["index","id","unique_name","value","type"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"value":{"description":"Checkbox selected value","type":"array","items":{"type":"integer","format":"int32"}},"type":{"description":"Component feedback type","default":"checkbox","type":"string"}}},"feedback_data":{"type":"object","description":"Object that will hold the form pages and custom parameters.","title":"feedback_data","required":["pages"],"properties":{"customParams":{"$ref":"#/definitions/json"},"pages":{"type":"array","items":{"$ref":"#/definitions/feedback_page"}}}},"feedback_dropdown":{"type":"object","title":"feedback_dropdown","required":["index","id","unique_name","value","type"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"value":{"description":"Dropdown selected value","type":"integer","format":"int32"},"type":{"description":"Component feedback type","default":"select","type":"string"}}},"feedback_grading":{"type":"object","title":"feedback_grading","required":["index","id","unique_name","value","type"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"value":{"description":"Grading selected value","type":"integer","format":"int32"},"type":{"description":"Component feedback type","default":"grading","type":"string"}}},"feedback_grading0to10":{"type":"object","title":"feedback_grading0to10","required":["index","id","unique_name","value","type"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"value":{"description":"Grading selected value","type":"integer","format":"int32"},"type":{"description":"Component feedback type","default":"grading0to10","type":"string"}}},"feedback_grading1to10":{"type":"object","title":"feedback_grading1to10","required":["index","id","unique_name","value","type"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"value":{"description":"Grading selected value","type":"integer","format":"int32"},"type":{"description":"Component feedback type","default":"grading1to10","type":"string"}}},"feedback_nps":{"type":"object","title":"feedback_nps","required":["index","id","unique_name","value","type"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"value":{"description":"NPS selected value","type":"integer","format":"int32"},"type":{"description":"Component feedback type","default":"nps","type":"string"}}},"feedback_page":{"type":"object","description":"Object that will hold the form page","title":"feedback_page","required":["components"],"properties":{"components":{"type":"array","items":{"$ref":"#/definitions/feedback_union"}}}},"feedback_radioSelector":{"type":"object","title":"feedback_radioSelector","required":["index","id","unique_name","value","type"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"value":{"description":"Radio Selected Value","type":"integer","format":"int32"},"type":{"description":"Component feedback type","default":"radio","type":"string"}}},"feedback_textArea":{"type":"object","title":"feedback_textArea","required":["index","id","unique_name","value","type"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"value":{"description":"Text Area Content","type":"string"},"type":{"description":"Component feedback type","default":"textArea","type":"string"}}},"feedback_textInput":{"type":"object","title":"feedback_textInput","required":["index","id","unique_name","value","type"],"properties":{"index":{"description":"Component index","type":"integer","format":"int32"},"id":{"description":"Component id","type":"integer","format":"int32"},"unique_name":{"description":"Unique name","type":"string"},"value":{"description":"Text Area Content","type":"string"},"type":{"description":"Component feedback type","default":"textInput","type":"string"}}},"form":{"type":"object","title":"form","required":["formId","name","title","formType","formJson"],"properties":{"formId":{"description":"Form Identifier","type":"integer","format":"int32"},"name":{"description":"Form name","type":"string"},"title":{"description":"Form title","type":"string"},"formType":{"type":"string","enum":["mobileInvitation","code"]},"inviteData":{"$ref":"#/definitions/inviteData"},"triggerData":{"$ref":"#/definitions/triggerData"},"formJson":{"$ref":"#/definitions/formJson"}}},"formJson":{"type":"object","title":"formJson","required":["pages"],"properties":{"pages":{"type":"array","items":{"$ref":"#/definitions/page"}}}},"image":{"type":"object","title":"image","required":["name","url"],"properties":{"name":{"description":"Image Name","type":"string"},"url":{"description":"Image Url","type":"string"}}},"inviteData":{"type":"object","title":"inviteData","required":["invitationHeadline","invitationText","provideButtonText","declineButtonText","laterButtonText"],"properties":{"invitationHeadline":{"description":"Invitation Headline","type":"string"},"invitationText":{"description":"Invitation Text","type":"string"},"provideButtonText":{"description":"Provide feedback button text","type":"string"},"declineButtonText":{"description":"Decline provide feedback button text","type":"string"},"laterButtonText":{"description":"Provide feedback later button text","type":"string"}}},"numberOfAppSession":{"type":"object","title":"numberOfAppSession","required":["number","compareString"],"properties":{"number":{"description":"Number of app sessions","type":"string"},"compareString":{"type":"string","enum":["greaterThan","equals","smallerThan"]}}},"numberOfDays":{"type":"object","title":"numberOfDays","required":["days"],"properties":{"days":{"description":"Don't invite a visitor who submitted feedback in the past x days","type":"string"}}},"page":{"type":"object","title":"page","required":["name","index","dynamicData"],"properties":{"name":{"description":"Page name","type":"string"},"index":{"description":"Page index","default":"0","type":"integer","format":"int32"},"dynamicData":{"type":"array","items":{"$ref":"#/definitions/component_union"}}}},"percentageOfSessions":{"type":"object","title":"percentageOfSessions","required":["prec"],"properties":{"prec":{"description":"Don't invite a visitor who submitted feedback in the past x days","type":"string"}}},"timeInForeground":{"type":"object","title":"timeInForeground","required":["time","compareString"],"properties":{"time":{"description":"Time in Foreground, in seconds","type":"string"},"compareString":{"type":"string","enum":["greaterThan","equals","smallerThan"]}}},"triggerData":{"type":"object","title":"triggerData","properties":{"numberOfAppSession":{"$ref":"#/definitions/numberOfAppSession"},"timeInForeground":{"$ref":"#/definitions/timeInForeground"},"mobileappVersion":{"description":"Mobile App Versions","type":"array","items":{"type":"string"}},"submitted":{"$ref":"#/definitions/numberOfDays"},"declined":{"$ref":"#/definitions/numberOfDays"},"mobileosVersion":{"description":"Mobile App Versions","type":"array","items":{"type":"string"}},"percentageOfSessions":{"$ref":"#/definitions/percentageOfSessions"},"genericRule":{"description":"Set of generic rules creates in the invitation settings","type":"string"}}},"component_union":{"type":"object","description":"Represents the question or fields to be filled by the user","title":"component_union","allOf":[{"$ref":"#/definitions/component_label"},{"$ref":"#/definitions/component_image"},{"$ref":"#/definitions/component_nps"},{"$ref":"#/definitions/component_textArea"},{"$ref":"#/definitions/component_textInput"},{"$ref":"#/definitions/component_radioSelector"},{"$ref":"#/definitions/component_checkbox"},{"$ref":"#/definitions/component_dropdown"},{"$ref":"#/definitions/component_grading"},{"$ref":"#/definitions/component_grading0to10"},{"$ref":"#/definitions/component_grading1to10"}]},"feedback_union":{"type":"object","description":"Represents the component or fields to be filled by the user","title":"feedback_union","allOf":[{"$ref":"#/definitions/feedback_nps"},{"$ref":"#/definitions/feedback_textArea"},{"$ref":"#/definitions/feedback_textInput"},{"$ref":"#/definitions/feedback_radioSelector"},{"$ref":"#/definitions/feedback_checkbox"},{"$ref":"#/definitions/feedback_dropdown"},{"$ref":"#/definitions/feedback_grading"},{"$ref":"#/definitions/feedback_grading0to10"},{"$ref":"#/definitions/feedback_grading1to10"}]}}}