Qrvey API Overview
The Qrvey RESTful API is a collection of functions that facilitate developers in embedding Qrvey features into their applications. There are three basic function groups.
- Those that create and manage user accounts
- Those that create and manage Qrvey’s and templates
- Those that return the analytical results
User Accounts are identified by a unique ID. They may refer to an individual or a group, depending on the developer’s need. That ID is used to organize Qrveys. Said another way, each Qrvey belongs to a unique User Account ID.
A Qrvey refers to any of the feedback applications; Quick Survey, Quick NPS, Quick Form, Quick Quiz, Audience Poll, On Page Poll, Checklist and Progressive Questions. Each feedback application gets a unique ID when it is created. A Qrvey template is a sharable, pre-defined Qrvey that may be customized for a specific use case.
The account management functions include the ability to add, update, and delete accounts (users), return a list of accounts and their details, return the details for a single account, get a list of the Qrvey’s taken by a user, and get the user’s responses to a Qrvey.
The Qrvey management functions are specific to each Qrvey type. They include the ability to create, update and delete Qrveys, return a list of all Qrveys with limited details, and activate, return the details of a specific Qrvey, activate a Qrvey, return the URL of a Qrvey, email the URL to a list of addresses, and return the results of a Qrvey. Qrvey template management functions include the ability to create, update and remove templates, return a list of all templates, and return the details of a specific template.
The functions that return Qrvey results include the ability to get the aggregated results from a Qrvey, return the crosstabbed results of a Qrvey, and return trend analysis for a single question, and individual responses to a Qrvey question.
All of the functions depend on identifying the target object. The hierarchy is as follows:
- API Key – a unique value for each customer
- Account ID – a unique value for each user or group
- Qrvey ID – a unique value for each feedback application
- Question ID – a unique value for each question
Logically a collection of questions is associated with a Qrvey, Qrveys are grouped by account, and accounts are grouped by customer.
See the API help for the full breakdown of the API calls.