Welcome to the Medallia documentation for Dimension! Integrating Dimension into your Medallia application is quick and easy.

Set Up Medallia API Access

Authenticate with Medallia Conversations API:

We will be integrating with the Medallia Conversations end point

Use OAuth 2.0 for authentication with Medallia.

Obtain the access token (${TOKEN}) for authentication. Follow the Medallia documentation for the authentication process.

Extract Conversations from Medallia

const options = {method: 'GET', headers: {accept: 'application/json'}};

fetch('https://conversations.sc4.medallia.com/apis/v0/channels/channel-guid/conversations', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

curl --request GET \
     --url https://conversations.sc4.medallia.com/apis/v0/channels/channel-guid/conversations \
     --header 'accept: application/json'

Send the Query via a POST request:

https://{conversations-api-gateway-hostname}/apis/v0/channels/{channel-guid}/conversations

Headers:
- Authorization: Bearer ${TOKEN}
- Content-Type: application/json

Send the request to get survey responses.

POST responses to Dimension

When your survey receives a response, post the data to the following endpoint:

https://tracker.dimensionlabs.io/track?platform=universal&v=10.1.1-rest&type=incoming&apiKey=API_KEY_HERE

Make sure to set the ‘Content-Type’ header to ‘application/json’ and to replace API_KEY_HERE with your api key.

You must send the data with the following fields:

text – string – (required)
userId – string – (required) – should be the SAME userId for both incoming and outgoing messages this is NOT the bot’s user ID

To review all optional fields see our API reference.

The data to POST should pass the following data:

{
  "text": "Hi, bot",
  "userId": "+14155551234",
  "platformJson": {
    "whateverJson": "any JSON specific to your platform can be stored here"
  }
}

Sample cURL

curl -X POST -H "Content-Type: application/json"
     -d '{"text":"Hi, bot","userId":"+14155551234","platformJson":{"whateverJson":"any JSON specific to your platform can be stored here"}}'
     'https://tracker.dimensionlabs.io/track?platform=sms&v=11.1.0-rest&type=incoming&apiKey=API_KEY'

Notice, you must replace the placeholder API_KEY_HERE above with your api key.