Skip to main content

A Python client for the Cmix API.

Project description

python-cmixapi-client

PyPI version

GitHub Actions status

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

authenticate(*args, **kwargs)
fetch_banner_filter(survey_id, question_a, question_b, response_id)
fetch_raw_results(survey_id, payload)
get_surveys(status, *args, **kwargs)
get_survey_definition(survey_id)
get_survey_xml(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)

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python-cmixapi-client, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size python_cmixapi_client-0.1.2-py3-none-any.whl (10.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size python-cmixapi-client-0.1.2.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page