All our API endpoints require HTTP basic authentication as specified in RFC 7616 from 2015. The HTTP Header of your request must contain a header field in the form of:

Authorization: Basic {credentials}

Where {credentials} is the Base64 encoding of: your Client Portal Code, a single colon, and your API Key (found in the Preferences of the Portal).

Here's a snippet of PHP script using CURL to set the authentication header.

$portal_code = 'ABC123'; 
$api_key = 'SMzYECYJYLpNw8PrfX8EtPO2tcP0XaKJvZ4FW5VL';

$header = array('Authorization: Basic '. base64_encode($portal_code .":". $api_key) );

$curl_session = curl_init();
curl_setopt($curl_session, CURLOPT_HTTPHEADER, $header);

To use the Relationship Survey Responses endpoint, use the HTTP GET method with this URL:

https://app.cio-pulse.com/api/v5/rs-surveys

You can add any of the following parameters to this URL to define your filters. The first parameter must be prefixed with a ? and all subsequent parameters with a &:

Ths parameters defines the Relationship Survey you want to retrieve response for:

• rsid Mandatory. The Relationship Survey Code of the Relationship Survey.

These optional parameters define the period of time you want to return the surveys for:

• limit Optional. Specify a number, n, to limit the number of survey responses to the most recent n surveys that meet the selection criteria. n must be 10000 or less. Cannot be used with the isofrom, isoto or eom parameters.
• isofrom Optional. Return responses received on or after this UTC/GMT date/time. The date/time must be in ISO8601 format:  yyyy-mm-ddThh:mm:ssZ, e.g. 2016-10-13T16:30:00Z. Cannot be used with the limit or eom parameters.
• isoto Optional.  Return responses received on or before this UTC/GMT date/time. The date/time must be in ISO8601 format:  yyyy-mm-ddThh:mm:ssZ, e.g. 2016-10-14T16:29:59Z. Cannot be used with the limit or eom parameters.

These optional parameters define the Customer Segments you wish to retrieve surveys for:

• sgid1 Optional. Include surveys for this Customer Segment 1.
• sgid2 Optional. Include surveys for this Customer Segment 2

Additional filter parameters:

• min Optional. Returns survey responses where overall satisfaction rating > = this value (1-10).
• max Optional. Returns survey responses where overall satisfaction rating < = this value (1-10).

The surveys returned by the API look like this (which shows three surveys):

{"surveys":[

{"survey":{"Response_ID":"3","Relationship_Survey_Code":"JAN21","Relationship_Survey_Name":"RS 2021","Series_Code":"NONE","Series_Name":"No Series","Response_Datetime_UTC":"2021-01-10
08:50:12","Segment_Code":"Operations","Segment_Name":"Operations",
"Segment_2_Code":"Staff","Segment_2_Name":"Staff",
"Customer":"712017","Rating":"9","Rating_Reason":"Best IT department I've ever known","Suggested_Improvement":"Help desk at weekends would be nice",
"Survey_Description":"CIOPulse RS -
Democorp","Survey_Language":"English"}},

{"survey":{"Response_ID":"4","Relationship_Survey_Code":"JAN21","Relationship_Survey_Name":"RS 2021,"Series_Code":"NONE","Series_Name":"No Series","Response_Datetime_UTC":"2021-01-10
08:54:30","Segment_Code":"Sales","Segment_Name":"Sales",
"Segment_2_Code":"Staff","Segment_2_Name":"Staff",
"Customer":"711267","Rating":"6","Rating_Reason":"ERP system is clunky, slow and old fashioned","Suggested_Improvement":"Upgrade to a modern ERP!",
"Survey_Description":"CIOPulse RS - DemoCorp","Survey_Language":"English"}}

]}

If there is a problem, one of these error codes will be returned in the HTTP header:

• 401 Invalid security credentials (Client Portal Code and/or API key invalid).
• 400 Malformed syntax, e.g. missing/invalid parameters.
• 422 Valid syntax but not processed due to business rules (e.g. max > min or isoto > isofrom).
• 404 No surveys found that match the criteria specified.
• 500 Server error, e.g. database connection couldn't be established.

In each of these error situations, a description of the error will also be returned in JSON format.

{"message":"No surveys were found that matched this criteria","status":404}