Resources Enums Models Unions Clients

medallia-api 0.0.1

History | Watch

API for Medallia Surveys system

Resources

access_token_wrapper

Operations

Method and Path Description
POST /accessToken

This API is used to retrieve the temporary access token that allows your app to access all other APIs

configuration

Operations

Method and Path Description
GET /configuration

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.

feedback

Operations

Method and Path Description
POST /feedback

This API allows the application to submit feedback collected in the app to the Medallia Digital

Headers

Name Type Required? Default Description
Authentication string Yes -

Authentication header, it can be a request Token or an access Token

Imports

https://app.apibuilder.io/edsancha/survey-models/0.0.1/service.json

Enums

compareString

Name Value Description
greaterThan greaterThan
equals equals
smallerThan smallerThan

formType

Name Value Description
mobileInvitation mobileInvitation
code code

ratingViewType

Name Value Description
slide slide
numbersSquare numbersSquare
gradingSlider gradingSlider
gradingDropdown gradingDropdown
stars stars
emoticons emoticons
numbers numbers
smilies smilies
bars bars

Interfaces

No interfaces

Models

access_token_wrapper

Example Json: Minimal | Full

Interfaces: None

JWT Access Token to be used to access the APIe

Field Type Required? Default Description
accessToken string Yes -

JWT Access Token to be used to access the API

component_checkbox

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
required boolean Yes -

Component required
label string Yes -

Component label
options [string] Yes -

Maximum number of characters
description string No -

Component description

component_dropdown

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
required boolean Yes -

Component required
placeholder string Yes -

Component placeholder
label string Yes -

Component label
options [string] Yes -

Maximum number of characters
description string No -

Component description

component_grading

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
required boolean Yes -

Component required
label string Yes -

Component label
ratingViewType ratingViewType Yes gradingSlider

Rating View Type
description string No -

Component description

component_grading0to10

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
required boolean Yes -

Component required
label string Yes -

Component label
ratingViewType ratingViewType Yes gradingSlider

Rating View Type
description string No -

Component description

component_grading1to10

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
required boolean Yes -

Component required
label string Yes -

Component label
ratingViewType ratingViewType Yes gradingSlider

Rating View Type
description string No -

Component description

component_image

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
imageObject image No -

Image Object uploaded to Medallia, if it's a copy of a previous survey this field doesnt' show up
uploadedResource image No -

Image Object from a copied survey, it only shows when imageObject is not present

component_label

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
labelContent string No -

Label Content
num_of_lines integer Yes 2

Label Number of Lines

component_nps

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
required boolean Yes -

Component required
label string Yes -

Component placeholder
description string No -

Component description
ratingViewType ratingViewType Yes slide

Rating View Type

component_radioSelector

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
required boolean Yes -

Component required
label string Yes -

Component label
options [string] Yes -

Maximum number of characters
description string No -

Component description

component_textArea

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
required boolean Yes -

Component required
placeholder string Yes -

Component placeholder
label string Yes -

Component placeholder
num_of_lines integer Yes 2

Number of lines, string parameter though (－‸ლ)
description string No -

Component description

component_textInput

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
required boolean Yes -

Component required
placeholder string Yes -

Component placeholder
label string Yes -

Component label
max_chars integer Yes 200

Maximum number of characters
description string No -

Component description

configuration

Example Json: Minimal | Full

Interfaces: None

Configuration main object, including forms

Field Type Required? Default Description
propertyId integer Yes -

Account id
feedbackSubmitUrl string Yes -

url
forms [form] Yes -

Definition and configuration of forms that were created in the command center

dynamicData

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
required boolean Yes -

Component required
component string Yes -

Component type
unique_name string Yes -

Component unique name
placeholder string Yes -

Component placeholder
label string Yes -

Component placeholder
description string No -

Component description
options [string] No -

Options available if required
imageObject image No -

Image if required

feedback

Example Json: Minimal | Full

Interfaces: None

Feedback main object with survey's results

Field Type Required? Default Description
formId integer Yes -

The submitted form id (from the configuration).
dynamicData feedback_data Yes -

Survey Feedback Data

feedback_checkbox

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
value [integer] Yes -

Checkbox selected value
type string Yes checkbox

Component feedback type

feedback_data

Example Json: Minimal | Full

Interfaces: None

Object that will hold the form pages and custom parameters.

Field Type Required? Default Description
customParams json No -

List of survey's pages results
pages [feedback_page] Yes -

List of survey's pages results

feedback_dropdown

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
value integer Yes -

Dropdown selected value
type string Yes select

Component feedback type

feedback_grading

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
value integer Yes -

Grading selected value
type string Yes grading

Component feedback type

feedback_grading0to10

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
value integer Yes -

Grading selected value
type string Yes grading0to10

Component feedback type

feedback_grading1to10

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
value integer Yes -

Grading selected value
type string Yes grading1to10

Component feedback type

feedback_nps

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
value integer Yes -

NPS selected value
type string Yes nps

Component feedback type

feedback_page

Example Json: Minimal | Full

Interfaces: None

Object that will hold the form page

Field Type Required? Default Description
components [feedback_union] Yes -

List of survey's pages results

feedback_radioSelector

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
value integer Yes -

Radio Selected Value
type string Yes radio

Component feedback type

feedback_textArea

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
value string Yes -

Text Area Content
type string Yes textArea

Component feedback type

feedback_textInput

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
index integer Yes -

Component index
id integer Yes -

Component id
unique_name string Yes -

Unique name
value string Yes -

Text Area Content
type string Yes textInput

Component feedback type

form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
formId integer Yes -

Form Identifier
name string Yes -

Form name
title string Yes -

Form title
formType formType Yes -

Form type
inviteData inviteData No -

Invitation data
triggerData triggerData No -

Invitation trigger conditions
formJson formJson Yes -

Wrapper around form data

formJson

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
pages [page] Yes -

Form Page

image

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

Image Name
url string Yes -

Image Url

inviteData

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
invitationHeadline string Yes -

Invitation Headline
invitationText string Yes -

Invitation Text
provideButtonText string Yes -

Provide feedback button text
declineButtonText string Yes -

Decline provide feedback button text
laterButtonText string Yes -

Provide feedback later button text

numberOfAppSession

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
number string Yes -

Number of app sessions
compareString compareString Yes -

Compare String

numberOfDays

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
days string Yes -

Don't invite a visitor who submitted feedback in the past x days

page

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

Page name
index integer Yes 0

Page index
dynamicData [component_union] Yes -

percentageOfSessions

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
prec string Yes -

Don't invite a visitor who submitted feedback in the past x days

timeInForeground

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
time string Yes -

Time in Foreground, in seconds
compareString compareString Yes -

Compare String

triggerData

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
numberOfAppSession numberOfAppSession No -

Number of App Sessions to show the invite, with compare string
timeInForeground timeInForeground No -

App Time in foreground in seconds to show the invite, with compare string
mobileappVersion [string] No -

Mobile App Versions
submitted numberOfDays No -

Don't invite a visitor who submitted feedback in the past x days
declined numberOfDays No -

Don't invite a visitor who declined an invitation in the past x days
mobileosVersion [string] No -

Mobile App Versions
percentageOfSessions percentageOfSessions No -

Invite to this percentage of sessions
genericRule string No -

Set of generic rules creates in the invitation settings

Unions

component_union

Interfaces: None

  • Type discriminator: component

Represents the question or fields to be filled by the user

Type Discriminator Value Example Json Description
component_label label Minimal | Full

component_image image Minimal | Full

component_nps nps Minimal | Full

component_textArea textArea Minimal | Full

component_textInput textInput Minimal | Full

component_radioSelector radio Minimal | Full

component_checkbox checkbox Minimal | Full

component_dropdown select Minimal | Full

component_grading grading Minimal | Full

component_grading0to10 grading0to10 Minimal | Full

component_grading1to10 grading1to10 Minimal | Full

feedback_union

Interfaces: None

  • Type discriminator: component

Represents the component or fields to be filled by the user

Type Discriminator Value Example Json Description
feedback_nps nps Minimal | Full

feedback_textArea textArea Minimal | Full

feedback_textInput textInput Minimal | Full

feedback_radioSelector radio Minimal | Full

feedback_checkbox checkbox Minimal | Full

feedback_dropdown select Minimal | Full

feedback_grading grading Minimal | Full

feedback_grading0to10 grading0to10 Minimal | Full

feedback_grading1to10 grading1to10 Minimal | Full

Annotations

No annotations