API Reference

Clients

API Client

API clients form the basis for making API requests. Typically, you will use the QuantAQAPIClient which will connect you directly to the QuantAQ website. If using an enterprise version of the QuantAQ API and server, you can build your own API client following the instructions in the Usage section.

client.ClientBase([api_key, base_url, version])	A client for accessing the QuantAQ API.
client.APIClient(base_url[, api_key, version])
client.DevelopmentAPIClient([api_key])
client.StagingAPIClient([api_key])
client.ProductionAPIClient([api_key])
QuantAQAPIClient	alias of quantaq.client.ProductionAPIClient

API Endpoints

The following is an extensive list of all available API endpoints. Please check the Usage section for instructions on how to use them.

Users Endpoints

endpoints.users.Users.list(**kwargs)	Return all (available) users.
endpoints.users.Users.get(**kwargs)	Return user with id = id.
endpoints.users.Users.update(**kwargs)	Update the record of a user with id = user_id

Organizations Endpoints

endpoints.organizations.Organizations.list(...)	Return a list of organizations accessible by the account.
endpoints.organizations.Organizations.get(...)	Return organizations with id = id.

Networks Endpoints

endpoints.networks.Networks.list(**kwargs)	Return a list of networks accessible by the account, in the context of the organization with id=organization_id.
endpoints.networks.Networks.get(**kwargs)	Return network with id=network_id in organization with id=organization_id.

Devices Endpoints

endpoints.devices.Devices.list(**kwargs)	Return all (available) devices.
endpoints.devices.Devices.get(**kwargs)	Return device with sn = sn.
endpoints.devices.Devices.update(**kwargs)	Update the record of a device with sn = sn
endpoints.devices.Devices.add(**kwargs)	Add a new device.
endpoints.devices.Devices.drop(**kwargs)	Delete a device.

Data Endpoints

endpoints.data.Data.list(**kwargs)	Return all data for device with serial number sn.
endpoints.data.Data.bydate(**kwargs)	Return all data for a device with serial number <sn> on date <date>.
endpoints.data.Data.get(**kwargs)	Return a single data point.

Logs Endpoints

endpoints.logs.Logs.list(**kwargs)	Return a list of logs for device with serial number sn.
endpoints.logs.Logs.get(**kwargs)	Return a single log.
endpoints.logs.Logs.update(**kwargs)	Update a log record.
endpoints.logs.Logs.drop(**kwargs)	Delete the log record.

Cellular Logs Endpoints

endpoints.cellular.Cellular.list(**kwargs)	Return a list of cellular logs for a device with serial number sn.
endpoints.cellular.Cellular.drop(**kwargs)	Delete a cellular log record.

Models Endpoints

endpoints.models.Models.add(**kwargs)	Add a new calibration model for device with sn = serial number.
endpoints.models.Models.get(**kwargs)	Return the calibration models for device with sn = serial number.

Utilities

Utils

utils.to_dataframe(data, **kwargs)

Convert an array of dictionaries into a pd.DataFrame.