LogoLogo
  • Go to Docs Center
  • Welcome to Plum Insight
  • How to...
    • Use Plum's Transcription
  • Account Manager
    • Managing Phone Numbers
    • Managing User Settings
    • Managing Users
    • Managing Metadata
  • Creating A Survey
    • Survey Basics
    • Using Pages
    • Question Types
      • Multiple Choice
      • Multiselect
      • Scale
      • Yes/No
      • Comment
      • Date
      • Time
      • Currency
      • Number
      • Digits
      • Name
      • Address
      • Transfer
      • SOAP
      • Prompt
      • Subdialog
      • Metadata Filter
      • Metadata Store
      • Multilingual
  • Prompt Manager
    • Bulk Uploading for Audio Prompts
  • Survey Settings
    • Phone
    • Web
    • Mobile
  • Metadata Manager
    • Layout
    • Creating a Metadatabase
    • Viewing/Editing a Metadatabase
    • Managing a Metadatabase
    • Formatting Metadatabase CSV
  • Survey Manager
    • Locking Surveys
    • Sharing Surveys
    • Cloning Surveys
    • Clearing Survey Data
    • Deleting Surveys
    • Importing Surveys and Data
  • Deployment
    • Deployment Management
    • Outbound Queue
    • Queueing Calls
  • Reporting
    • Viewing a Report
    • Available Charts
    • Edit Filters
    • Survey Visits
    • Printer Friendly View
    • Single vs Multi-Survey Reports
    • Merging Questions
    • Translating Unix timestamps
  • API
    • Checking Total Responses for a Survey
    • Queuing an Outbound Call
    • Queuing Multiple Outbound Calls
    • Checking Status for an Outbound Call
    • Cancelling All Pending Outbound Calls
    • Adding Metadatabase Records
    • Survey Response Reporting
  • Data Integration
    • Automatic Web Services
    • Plum Insight Webservice Question Type
    • SOAP Integration
    • REST Integration
    • Subdialog Integration
    • Result URL
    • Associating Metadata with a Caller
Powered by GitBook
On this page
  • Insight API Overview
  • Base URL
  • Authentication
  • Supported Accept Headers
  • Locating your survey_id and instance_id

API

Insight API Overview

The Insight API provides a programmatic access to, and supports the following functionality within the Insight interface:

  • Survey responses: Returns the total number of times the survey has been taken.

  • Queue call: Queues a single outbound call.

  • Bulk queue calls: Queues outbound calls in batches from a CSV of contacts.

  • Outbound call status: Returns the call details for a specific outbound call.

  • Cancel calls: Schedules all pending outbound calls to be cancelled.

  • Metadatabase push: Adds a single metadatabase record to an existing metadatabase.

  • Survey Response Reporting: Returns survey responses for a saved report in text/csv format.

See here for information about using the Transcription API with Insight.

Base URL

The base url for all requests should be made to:

https://insight.plumvoice.com/api

Authentication

All API requests are authenticated using HTTP Basic Authentication. The username value will be the email address users use to log in to their Insight account and the password will be their Developer Key, located within the Account Settings interface.

Depending on the HTTP libraries available in one's chosen programming language, users may be able to use built-in HTTP Basic Authentication. If this is not available, users can build the header manually by base64 encoding their username and developer key concatenated with a colon and then prefixing it with 'Basic'. Manually built HTTP Basic Authentication in this instance should look like:

"Authentication: Basic your_base64_encoded_string"

Any requests made without this header or with invalid credentials will return HTTP 401 Unauthorized and the body will provide details about what went wrong with the request.Edit

Supported Accept Headers

The API methods honor the following Accept header values to determine the Content-Type and representation for the response:

  • application/json

  • application/xml

Specifying a different Accept header will return a Content-Type 'application/json' by default.Edit

Locating your survey_id and instance_id

Your survey_id and instance_id values are utilized in many areas of the Insight API. To locate these values for your survey, you'll need to visit the Outbound Queue. At the top you will see “Outbound API Values” which displays the survey_id and instance_id for your survey.

PreviousTranslating Unix timestampsNextChecking Total Responses for a Survey

Last updated 4 years ago