API Channel

API Channel




    










Data Collection & Distribution

User Manual — API Channel




D.5 API Channel 

5.1 Creating API Channel

API Channel is used to collect survey responses by integrating with your CRM. Through the API Channel, you can send surveys via SMS and Email, and schedule surveys, reminders, or thank you messages based on days, hours, or a specific date.

To create an API Channel:

1. On Distribute tab, click API Channel.

2. Enter Channel Name and click Next.

On API Details tab, you can copy all necessary parameters for distributing survey via API: 

 

Customizing Channel Features and Settings

You can further customize the channel settings and features, such as custom messages and delivery timings.

1. Click Configure to view and customize channel options.

Delivery Timings: Configure all scheduling through Delivery Timings. You can schedule your invitation, Reminder for partial response, Reminder for No Response, and Thank You message. The steps to scheduling are as follows:

  1. First, enable the type of message that you want to be sent automatically to the client.
  2. For Delivery Timings, set the countdown for the time the first invite is to be sent. You can set the countdown in date and time order. You can also select to send invite-only during weekdays or weekends or every day. 
  3. In partial and not respondent reminders you can choose to add the number of reminders to be sent and select its medium of sending the Message.
  4. In thank message, you can set the time and medium of sending the message.

You can customize the Channel setting by clicking the + next to each setting.

  1. IP Restriction: Allow surveys to be taken or blocked from specified IP addresses.
  2. Response Limit: Automatically close the channel after a chosen number of responses are recorded.
  3. Link Expiry: Set a time period after which the survey link should expire for the respondent.
  4. Gateway: Configure the Email Gateway and Sender ID from which the survey invitation needs to be sent.
  5. Remove duplicate invited contacts within days: Set a number of days within which duplicated contacts which were invited previously will not be invited.
  6. Remove duplicate respondent contacts within days: Set a number of days within which contacts who have responded to the survey and were invited previously will not be invited.
  7. Sender Name: Configure the primary name to appear with the survey invitation.
  8. Set Medium (Primary): Set a primary medium for the API channel.

  1. Survey Domain: Choose whether the survey link runs on a custom domain or the default platform domain. 
  2. Survey Sub Domain.: Define a custom subdomain segment for the survey URL. 
  3. Response Editing.: Decide if respondents can change their answers during or after the survey. 
  4. Intro page: Show or hide an introductory page before the first question. 

Default Conversational Thankyou Message: Configure a custom thank you message specific to the selected distribution channel which displays at the end of a survey. 

5.2 Track Activity for API Channel

The API Activity page tracks all your actions and activity related to the API Channel. You can view the emails and SMS you have sent to respondents. You can sort and filter individual respondents from the list using the available filters.

Filter available to you are:

  • Advance: This option allows you to search for respondents based on email id and mobile number. 
  • Date: This option is used to set a time frame. Only the API Channel communications sent during the filtered period are shown.
  • Response: This option lets you filter the respondents based on their response type. The available options are Not Responded, Responded, Partially Responded, Disqualified. You can send a reminder to those who have not responded yet. 
  • Status: This option lets you filter the Channel based on the status of whether the emails and text messages were delivered or not. The options available are — Failed, Delivered, Queued, Scheduled. 
  • Message: This lets you filter based on the type of message sent to respondents. The available options are– Invited, Reminder, Thank you. Invite refers to invite to fill the survey, Reminder refers to a reminder mail for survey and Thankyou refers to a thank you mail you have sent your respondents for filling the survey. 
  • Gateway: This option lets you filter your data based on Gateway you have used. 

Other options available on the activity page are:

  • Search: This option lets you manually search for specific information in the Channel response. 
  • Export to CSV/Excel: This option lets you export the entire API Channel data to an Excel or CSV Format. 

Understanding the table

The tabular data has numerous fields which, when used with filters, help you get precise data. The columns on the table are:

  • Created: This section shows you the time of the creation of the invite/reminder.
  • Sent To: This column shows the details of the respondents with whom you will share the survey.
  • Message Status: This tells you the status of the message — Delivered, Failed, Queued, Schedules.
  • Message Type: This tells you the content of the message—whether it is a reminder, invite or a thank you message.
  • Sent Time: This shows the time when the Channel was sent to respondents.
  • Response Status: This shows you the response status of the respondents from Not Responded, Responded, Partial, Disqualified.
  • Take Survey: This link can take you to the survey that was used. 
  • Message: This column shows the Message sent to the respondents.


5.3 Customizing Channel Features and Settings

SurveyHub allows you to do various customizations to an API Channel using numerous tools. 

Custom Message: This option allows you to edit the default message or add a custom template to be sent by a user as invites, reminders, and thank you messages and through SMS or Email. You get the option to edit the content for entire mail, including Heading, Subject, Body for different message types. 

Steps to adding Custom Message:

1. To edit the SMS/Email message, navigate to API Content.

2. Click the Edit button to change the message body.

3. You can add custom data such as the first name, or you can also enter the embedded data of your own choice by clicking Tags or Insert Survey Link.

4. Remember Survey Link is necessary for the body in SMS/Email and optional in subject part in email.

5. Click Proceed and Save.