Rest.md

Survey REST API

The Survey REST API lets you retrieve Survey data. This section describes how to integrate towards the Survey REST API.

How to connect

The API uses Auth0 for authentication and you will need to set up an account

Definitions

Description	Value	Comment
Method	GET
URL	https://{survey-host}/survey/rs/service/serviceId?from={}	Please contact Puzzel Support for the correct {survey-host}.
serviceId	The id of your service
from	Timestamp (format: YYYY-MM-DDTHH:MM:SS.SSSZ)
to	Timestamp (format: YYYY-MM-DDTHH:MM:SS.SSSZ)	Optional - will default to 'now' if not specified.

Request Example

https://{survey-host}/survey/v1/survey/rs/service/{serviceId}?from=2016-05-08T00:00:00.000%2B0200

Property list

Property Name	Data Type	Description
id	Integer	Unique integer identifier for Survey
surveyid	Integer	Manual Survey id
msisdn	String	End user's mobile number
agentid	String	Agent's name
queue	String	Identifier for queue
team	String	Identifier for team
rating	String	End user's score
response	String	End user's reply
follow_up_response	String	End user's follow up response
smsSentDate	String	Timestamp of the first SMS sent to the enduser
updated	String	Last modified
name	String	End user's name
address	String	End user's address
street	String	End user's street name
housenumber	String	End user's housenumber
entry	String	End user's entry
postnumber	String	End user's post number
postArea	String	End user's post area
extraParamName1	String	1. extra parameter name
extraParamName2	String	2. extra parameter name
extraParamName3	String	3. extra parameter name
extraParamName4	String	4. extra parameter name
extraParamName5	String	5. extra parameter name
extraParamValue1	String	1. extra value
extraParamValue2	String	2. extra value
extraParamValue3	String	3. extra value
extraParamValue4	String	4. extra value
extraParamValue5	String	5. extra value
comment	String	Your comment

JSON Response Example

Note that response objects depend on survey type.

• Survey type "CallCenter", will only return data in the callcenterSurveyList object.
• Survey type "NumberList", will only return data in the manualSurveyList object.
• Survey type "CallCenterAndNumberList", will return data in both callcenterSurveyList and manualSurveyList objects.

	{
		"timestamp": "2016-11-22T09:46:46.040+0100",
		"callcenterSurveyList": [
    		{
				"id": 4483,
		      	"surveyid": 0,
		      	"msisdn": "+4712345678",
		      	"agentid": "agent1",
		      	"queue": "queue1",
                "team": "team1",
		      	"rating": "8",
		      	"response": "5 abc",
                "follow_up_response": null,
		      	"smsSentDate": "2016-10-21T15:23:43.423+0200",
                "updated": "2016-10-21T15:27:04.387+0200",
		      	"name": "Minh Do Le",
		      	"address": "Brynsveien 13 ; 0667 Oslo",
				"street": "Brynsveien",
		      	"housenumber": "13",
				"entry": null,
		      	"postnumber": "0667",
		      	"postArea": "Oslo",
		      	"extraParamName1": "waitingTime",
		      	"extraParamName2": "callDuration",
		      	"extraParamName3": null,
		      	"extraParamName4": null,
		      	"extraParamName5": null,
		      	"extraParamValue1": "01:12:50",
		      	"extraParamValue2": "01:12:50",
		      	"extraParamValue3": null,
		      	"extraParamValue4": null,
		      	"extraParamValue5": null,
		      	"comment": null
			}
	  	],
		"manualSurveyList": []
	}