You can access the base object types that power Alchemer via the API. Objects include surveys, questions, responses, etc. These objects (for the most part) can be created, modified and deleted via the API. Most objects can also be used to return data associated with a survey. Here is a brief description of the objects we expose and how they can be used.
Account objects are customer account records of Alchemer. Using the API you can create new accounts (note: there is an additional approval step to do so), and pull the company name and contact information for the account for which you have a login.
Account teams are user teams, available in multi-user accounts, within Alchemer. Using the API you can create and delete account teams and pull and change details of existing account teams.
Account users are individual users of a Alchemer account. When you use OAuth with Alchemer you are accessing the application with the privileges of a particular user.
A contact list is a group of contacts that you can set up in the account's Email List system (our version of Contact Management). Think of these as mailing lists for sharing surveys. You can also use this as a basic CRM structure using the custom fields to store additional data, and survey responses linked to contacts.
Surveys are the heart-and-soul of Alchemer (obviously). Surveys come in four flavors in Alchemer: Surveys, Polls, Quizzes and Forms. For the purposes of the API all of these sub-types are accessed via the Survey object. There are a few things to keep in mind about the Survey object:
- Surveys are essentially collection of SurveyPages and SurveyQuestions
- All Surveys (except Polls) have at least two pages.
- Terminal pages are pages that flag a survey as complete and do not allow the respondent to move back in the survey.
Data is stored in Alchemer databases as a survey response. You can submit and edit survey responses through the API. Survey responses have several statuses: In Progress, Hit, Saved, Partial, Complete, Abandoned, Disqualified and Overflow. Overflow responses cannot be accessed by the API as these are responses collected beyond the monthly limit for the particular account.
This object pulls aggregate statistics about your collected survey data. The basic statistics are: total responses, sum, average, standard deviation, max and min values.
The SurveyPage object is a container for SurveyQuestions. As a collection, they also outline the flow of the survey from beginning to end (unless logic intervenes). Pages have a couple of returned fields, however, for the most part, they act as simple containers to define the survey or form.
The SurveyQuestion object is the most varied object in the Alchemer platform. As with Survey object, questions come in multiple sub-types (over 40 of them). The most common types are “textbox,” ”radio” and ”checkbox.” These correlate with form elements that every web developer is familiar with. In some cases, questions act like parent containers for sub-questions. An example of this is a table of radio buttons, where each row of the table is represented by separate radio-type SurveyQuestion with a shared collection of survey options.
The SurveyOption is a potential answer for a multiple-select/multiple-answer SurveyQuestion. For example, if you have radio button question with three possible answers, “lions,” ”tigers” and “bears,” these would be represented as three SurveyOption objects within a radio-type SurveyQuestion. SurveyOptions have their own sub-options for controlling order, exclusivity and language translations.
The SurveyReport object allows you get list of reports for a given survey, get a specfied report as well as copy and delete reports.
When surveys are created a default SurveyCampaign is created (a basic survey link). SurveyCampaigns come in many types and while many share basic link settings, they also have custom settings -- the most notable variation is the Email-Invitation subtype of the Survey Campaign.
Email Messages are part of an EmailCampaign. They come in three types: Initial Message (sent to everyone in the campaign), Reminder (sent only to those who have not completed the survey) and Thank You (sent to those who do complete).
The Contact object represents a person (keyed by email address) which can receive Email Invitations.