Alchemer¶

Overview¶

Alchemer is an online research tool that allows users to field surveys. This Parsons class allows users to retrieve surveys and survey results.

Note

Alchemer was formerly known as SurveyGizmo.

Note

Authentication: To use the class, you need to provide an Alchemer API token and API token secret. For more information, see Alchemer API authentication documentation.

Quick Start¶

To instantiate the Alchemer class, you can either store your API token and API secret token as environmental variables (SURVEYGIZMO_API_TOKEN and SURVEYGIZMO_API_TOKEN_SECRET, respectively) or pass in the tokens arguments.

API¶

class parsons.alchemer.alchemer.Alchemer(api_token=None, api_token_secret=None, api_version='v5')[source]¶

Instantiate Alchemer Class

Parameters:

api_token – The Alchemer-provided application token. Not required if ALCHEMER_API_TOKEN env variable set.
api_token – The Alchemer-provided application token. Not required if ALCHEMER_API_TOKEN_SECRET env variable set.
api_version – The version of the API that you would like to use. Not required if ALCHEMER_API_VERSION env variable set. Default v5

Returns:

Alchemer Class

get_surveys(page=None)[source]¶

Get a table of lists under the account.

Parameters:: page – int Retrieve a specific page of responses. If not given, then all pages are retrieved.
Returns:: Table Class

get_survey_responses(survey_id, page=None)[source]¶

Get the responses for a given survey.

Parameters:

survey_id – string The id of survey for which to retrieve the responses.
page – int Retrieve a specific page of responses. If not given, then all pages are retrieved.

Returns:

Table Class