Requesting Resources

The next examples follow the order from the API documentation.

Credentials can be created via the Mopinion Suite at Integrations » Feedback API in the classic interface or in the Raspberry interface, provided your package includes API access.

You can also take a look at this link with the steps to get private_key and public_key

General

API Docs for General.

After installation, open a python terminal and set the public_key, and private_key, you can set them as environment vars.

>>> from mopinion import MopinionClient
>>> PUBLIC_KEY = os.environ.get("YOUR_PUBLIC_KEY")
>>> PRIVATE_KEY = os.environ.get("YOUR_PRIVATE_KEY")
>>> SIGNATURE_TOKEN = os.environ.get("YOUR_SIGNATURE_TOKEN")

A token signature is retrieved from the API and set to signature_token attribute.

>>> client = MopinionClient(public_key=PUBLIC_KEY, private_key=PRIVATE_KEY)
>>> assert SIGNATURE_TOKEN == client.signature_token  # client requests the signature token

To see the availability of the API you can call is_available().

>>> assert client.is_available()
>>> r = client.is_available(verbose=True)
>>> assert r["code"] == 200 and r["response"] == "pong" and r["version"] == "2.0.0"

We can use it as a context Manager as well.

>>> with MopinionClient(public_key=PUBLIC_KEY, private_key=PRIVATE_KEY) as client:
...     assert client.is_available()
...     r = client.is_available(verbose=True)
...     assert r["code"] == 200 and r["response"] == "pong" and r["version"] == "2.0.0"

Examples with `mopinion.MopinionClient.resource`

This set of examples use the method resource from the MopinionClient.

Resource Account

API Docs for Account.

Get your account.

>>> response = client.resource(resource_name="account")
>>> assert response.json()["_meta"]["code"] == 200
>>> response.json()
{'name': 'Mopinion', 'package': 'Growth', 'enddate': '2021-02-13 00:00:00', 'number_users': 10, ...

Get your account in YAML format.

>>> import yaml
>>> response = client.resource("account", content_negotiation="application/x-yaml")
>>> r = yaml.safe_load(response.text)
>>> assert r["_meta"]["code"] == 200

When requesting with verbosity='quiet' no _meta info is returned.

>>> response = client.resource("account", verbosity="quiet")
>>> assert "_meta" not in response.json()

Resource Deployments

API Docs for Deployments.

Getting deployments.

>>> response = client.resource(resource_name="deployments")
>>> assert response.json()["_meta"]["code"] == 200
>>> response.json()
{'0': {'key': 'defusvnns6mkl2vd3wc0wgcjh159uh3j', 'name': 'Web Feedback Deployment'}, '_meta':...

Getting a specific deployment.

>>> response = client.resource("deployments", "my_deployment_id")
>>> assert response.json()["_meta"]["code"] == 200

Resource Datasets

API Docs for Datasets.

Getting a dataset.

>>> response = client.resource(resource_name="datasets", resource_id=1234)
>>> assert response.json()["_meta"]["code"] == 200

Get fields for a dataset.

>>> response = client.resource("datasets", 1234, "fields")
>>> assert response.json()["_meta"]["code"] == 200

Resource Fields

API Docs for Fields.

Get fields for a dataset.

>>> response = client.resource("datasets", 1234, "fields")
>>> assert response.json()["_meta"]["code"] == 200

Get fields for a report.

>>> response = client.resource("reports", 1234, "fields")
>>> assert response.json()["_meta"]["code"] == 200

Resource Feedback

API Docs for Feedback.

Note

There are three query parameters available for this resource.

limit (int <= 100) Maximum number of results in response/
page (int) Return result page.
filter (string) Filter feedback results. Click here for more info about filters.

Get feedback from a dataset.

>>> params = {"page": 1}
>>> response = client.resource("datasets", 1234, "feedback", query_params=params)
>>> assert response.json()["_meta"]["code"] == 200

Get feedback for a report.

>>> params = {"limit": 50, "filter[ces]": "3"}
>>> response = client.resource("reports", 1234, "feedback", query_params=params)
>>> assert response.json()["_meta"]["code"] == 200

Resource Reports

API Docs for Reports.

Get some basic info on a report.

>>> response = client.resource("reports", 1234)
>>> assert response.json()["_meta"]["code"] == 200

Examples with `mopinion.MopinionClient.request`

This set of examples use the method request from the MopinionClient.

Resource Account

API Docs for Account.

Get your account.

>>> response = client.request("/account")
>>> assert response.json()["_meta"]["code"] == 200
>>> print(response.json())
{'name': 'Mopinion', 'package': 'Growth', 'enddate': '2021-02-13 00:00:00', 'number_users': 10, ...

Get your account in YAML format.

>>> import yaml
>>> response = client.request("/account", content_negotiation="application/x-yaml")
>>> r = yaml.safe_load(response.text)
>>> assert r["_meta"]["code"] == 200

When requesting with verbosity='quiet' no _meta info is returned.

>>> response = client.request("/account", verbosity="quiet")
>>> assert "_meta" not in response.json()

Resource Deployments

API Docs for Deployments.

Getting deployments.

>>> response = client.request("/deployments")
>>> assert response.json()["_meta"]["code"] == 200

Getting a specific deployment.

>>> response = client.request("/deployments/my_deployment")
>>> assert response.json()["_meta"]["code"] == 200

Resource Datasets

API Docs for Datasets.

Getting a dataset.

>>> response = client.request("/datasets/1234")
>>> assert response.json()["_meta"]["code"] == 200

Get fields for a dataset.

>>> response = client.request("/datasets/1234/fields")
>>> assert response.json()["_meta"]["code"] == 200

Resource Fields

API Docs for Fields.

Get fields for a dataset.

>>> response = client.request("/datasets/1234/fields")
>>> assert response.json()["_meta"]["code"] == 200

Get fields for a report.

>>> response = client.request("/reports/1234/fields")
>>> assert response.json()["_meta"]["code"] == 200

Resource Feedback

API Docs for Feedback.

Note

There are three query parameters available for this resource.

limit (int <= 100) Maximum number of results in response/
page (int) Return result page.
filter (string) Filter feedback results. Click here for more info about filters.

Get feedback from a dataset.

>>> params = {"limit": 50, "filter[ces]": "3"}
>>> response = client.request("/datasets/1234/feedback", query_params=params)
>>> assert response.json()["_meta"]["code"] == 200

Get feedback from a report.

>>> params = {"page": 1}
>>> response = client.request("/reports/1234/feedback", query_params=params)
>>> assert response.json()["_meta"]["code"] == 200

Resource Reports

API Docs for Reports.

Get some basic info on a report.

>>> response = client.request("/reports/1234")
>>> assert response.json()["_meta"]["code"] == 200

Examples with GET methods

Resource Account

API Docs for Account.

Get your account.

>>> response = client.get_account()
>>> assert response.json()["_meta"]["code"] == 200
>>> response.json()
{'name': 'Mopinion', 'package': 'Growth', 'enddate': '2021-02-13 00:00:00', 'number_users': 10, ...

Get your account in YAML format.

>>> import yaml
>>> response = client.get_account(content_negotiation="application/x-yaml")
>>> r = yaml.safe_load(response.text)
>>> assert r["_meta"]["code"] == 200

When requesting with verbosity='quiet' no _meta info is returned.

>>> response = client.get_account(verbosity="quiet")
>>> assert "_meta" not in response.json()

Resource Deployments

API Docs for Deployments.

Getting deployments.

>>> response = client.get_deployments()
>>> assert response.json()["_meta"]["code"] == 200
>>> response.json()
{'0': {'key': 'defusvnns6mkl2vd3wc0wgcjh159uh3j', 'name': 'Web Feedback Deployment'}, '_meta':...

Getting a specific deployment.

>>> response = client.get_deployments(deployment_id="my_deployment_id")
>>> assert response.json()["_meta"]["code"] == 200

Resource Datasets

API Docs for Datasets.

Getting specific dataset.

>>> response = client.get_datasets(dataset_id=1234)
>>> assert response.json()["_meta"]["code"] == 200

Resource Fields

API Docs for Fields.

Get fields for a dataset.

>>> response = client.get_datasets_fields(dataset_id=1234)
>>> assert response.json()["_meta"]["code"] == 200

Get fields for a report.

>>> response = client.get_reports_fields(report_id=1234)
>>> assert response.json()["_meta"]["code"] == 200

Resource Feedback

API Docs for Feedback.

Note

There are three query parameters available for this resource.

limit (int <= 100) Maximum number of results in response/
page (int) Return result page.
filter (string) Filter feedback results. Click here for more info about filters.

Get feedback from a dataset.

>>> params = {"page": 1}
>>> response = client.get_datasets_feedback(dataset_id=1234, query_params=params)
>>> assert response.json()["_meta"]["code"] == 200

Get feedback for a report.

>>> params = {"limit": 50, "filter[ces]": "3"}
>>> response = client.get_reports_feedback(report_id=1234, query_params=params)
>>> assert response.json()["_meta"]["code"] == 200

Resource Reports

API Docs for Reports.

Get some basic info on a report.

>>> response = client.get_reports(report_id=1)
>>> assert response.json()["_meta"]["code"] == 200

Examples with the iterator

When working with the API there is a limit of elements retrieved. The limit parameters default to 10. You can increase the limit, or you can request resources using the flag generator=True. This returns a Generator which traverses these pages for you and yields each result on the current page before retrieving the next page.

>>> iterator = client.resource("deployments", iterator=True)
>>> response = next(iterator)
>>> assert response.json()["_meta"]["code"] == 200

Requesting fields for a dataset.

>>> iterator = client.resource("datasets", 1234, "fields", iterator=True)
>>> response = next(iterator)
>>> assert response.json()["_meta"]["code"] == 200

Also, for example, requesting fields for a report.

>>> iterator = client.resource("reports", 1234, "fields", iterator=True)
>>> response = next(iterator)
>>> assert response.json()["_meta"]["code"] == 200

Requesting Resources

General

Examples with mopinion.MopinionClient.resource

Resource Account

Resource Deployments

Resource Datasets

Resource Fields

Resource Feedback

Resource Reports

Examples with mopinion.MopinionClient.request

Resource Account

Resource Deployments

Resource Datasets

Resource Fields

Resource Feedback

Resource Reports

Examples with GET methods

Resource Account

Resource Deployments

Resource Datasets

Resource Fields

Resource Feedback

Resource Reports

Examples with the iterator

Examples with `mopinion.MopinionClient.resource`

Examples with `mopinion.MopinionClient.request`