python-cmixapi-client

A Python client library for the Dynata Cmix API.

Setup

pip install python-cmixapi-client

Example Usage

from CmixAPIClient.api import CmixAPI

cmix = CmixAPI(
    username="test_username",
    password="test_password",
    client_id="test_client_id",
    client_secret="test_client_secret"
)
cmix.authenticate()
surveys = cmix.get_surveys('closed')

Supported API Functions

CmixAPI

authenticate(*args, **kwargs)
fetch_banner_filter(survey_id, question_a, question_b, response_id)
fetch_raw_results(survey_id, payload)
get_projects()
get_surveys(status, *args, **kwargs)
get_survey_data_layouts(survey_id)
get_survey_definition(survey_id)
get_survey_locales(survey_id)
get_survey_xml(survey_id)
get_survey_sections(survey_id)
get_survey_simulations(survey_id)
get_survey_termination_codes(survey_id)
get_survey_sources(survey_id)
get_survey_test_url(survey_id)
get_survey_respondents(survey_id, respondent_type, live)
get_survey_status(survey_id)
get_survey_completes(survey_id)
create_export_archive(survey_id, export_type)
get_archive_status(survey_id, archive_id, layout_id)
update_project(project_id, status=None)
create_survey(xml_string)

CmixProject

delete_group(group_id)
delete_project()
get_full_links()
get_groups()
get_links()
get_locales()
get_markup_files()
get_project()
get_respondent_links()
get_sources()
get_surveys()

Contributing

Information on contributing to this python library.

Testing

To run the tests,

virtualenv venv
. venv/bin/activate
pip install -r requirements.txt
pytest
deactivate

to run the tests for this project.