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 CCS Survey Responses endpoint, use the HTTP GET method with this URL:

https://app.cio-pulse.com/api/v5/ccs-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 &:

These parameters define the entity you want to return the CCS responses for:

• rgid Optional. Include CCS feedback for the Team or Department with this Support Group Code.
• combine  Optional.  Only used when rgid specified. When y, includes CCS feedback for the Department and for the Teams that belong to that Department. When n, includes CCS feedback just for the Department. This parameter is ignored when the Support Group Code specifies a Team rather than a Department. You can learn more about how the combine parameter works, in this article.
• ccstypes Optional. Any combination of three 1s and 0s, enabling you to choose what sort of feedback to display, e.g. 100 for Compliments only; 010 for Complaints only; 011 for Complaints and Compliments. Defaults to 111.
• limit Optional. Specify a number, n, to limit the number of CCS responses to the most recent n responses that meet the selection criteria. n must be 10000 or less.
• isofrom Optional. Include CCS feedback 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
• isoto Optional.  Include CCS feedback 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

A normal response will result in an HTTP response code of 200 being returned in the header.

The feedback returned by the API look like this (which shows 3 responses):

{"surveys":[

{"survey":{"Response_ID":"57","Response_Datetime_UTC":"2019-12-05 02:27:40","Reference":"CCS0000000057","Support_Group_Code":"demosd","Support_Group_Name":"Service Desk","Feedback_Type":"Compliment","Feedback":"encoded cpc chrome","Contact_Permission_Type":"Contact me","Contact_Details":"123","Survey_Description":"English CCS form","Survey_Language":"English"}},

{"survey":{"Response_ID":"58","Response_Datetime_UTC":"2019-12-05 02:29:37","Reference":"CCS0000000058","Support_Group_Code":"demosd","Support_Group_Name":"Service Desk","Feedback_Type":"Compliment","Feedback":"rgid space ff","Contact_Permission_Type":"Contact me","Contact_Details":"123","Survey_Description":"CIOPulse CCS - Democorp","Survey_Language":"English"}},

{"survey":{"Response_ID":"59","Response_Datetime_UTC":"2020-03-25 02:30:26","Reference":"CCS0000000059","Support_Group_Code":"demosd","Support_Group_Name":"Service Desk","Feedback_Type":"Compliment","Feedback":"rgid space chrome","Contact_Permission_Type":"Contact me","Contact_Details":"123","Survey_Description":"CIOPulse CCS - 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 compliments, complaints or suggestions 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 compliments, complaints or suggestions were found that matched this criteria","status":404}