Better living through data.


Keywords
php, api, sdk, swagger
License
Other

Documentation

QuantiModoClient

We make it easy to retrieve and analyze normalized user data from a wide array of devices and applications. Check out our docs and sdk's or contact us.

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 5.8.112511
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/quantimodo/quantimodo-sdk-php.git"
    }
  ],
  "require": {
    "quantimodo/quantimodo-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/QuantiModoClient/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: access_token
QuantiModo\Client\Configuration::getDefaultConfiguration()->setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// QuantiModo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: quantimodo_oauth2
QuantiModo\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new QuantiModo\Client\Api\AnalyticsApi();
$body = new \QuantiModo\Client\Model\VoteDelete(); // \QuantiModo\Client\Model\VoteDelete | The cause and effect variable names for the predictor vote to be deleted.
$user_id = 3.4; // float | User's id

try {
    $result = $api_instance->deleteVote($body, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->deleteVote: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://app.quantimo.do/api

Class Method HTTP request Description
ActivitiesApi getActivities GET /v3/activities Get Activities
ActivitiesApi postActivities POST /v3/activities Post Activities
AnalyticsApi getCorrelationExplanations GET /v3/correlations/explanations Get correlation explanations
AnalyticsApi getCorrelations GET /v3/correlations Get correlations
AppSettingsApi getAppSettings GET /v3/appSettings Get client app settings
AuthenticationApi getAccessToken GET /v3/oauth2/token Get a user access token
AuthenticationApi getOauthAuthorizationCode GET /v3/oauth2/authorize Request Authorization Code
AuthenticationApi postGoogleIdToken POST /v3/googleIdToken Post GoogleIdToken
ConnectorsApi connectConnector GET /v3/connectors/{connectorName}/connect Obtain a token from 3rd party data source
ConnectorsApi disconnectConnector GET /v3/connectors/{connectorName}/disconnect Delete stored connection info
ConnectorsApi getConnectors GET /v3/connectors/list List of Connectors
ConnectorsApi getIntegrationJs GET /v3/integration.js Get embeddable connect javascript
ConnectorsApi getMobileConnectPage GET /v3/connect/mobile Mobile connect page
ConnectorsApi updateConnector GET /v3/connectors/{connectorName}/update Sync with data source
FeedApi getFeed GET /v3/feed Tracking reminder notifications, messages, and study results
FeedApi postFeed POST /v3/feed Post user interactions with feed
FriendsApi getFriends GET /v3/friends Get Friends
FriendsApi postFriends POST /v3/friends Post Friends
GroupsApi getGroups GET /v3/groups Get Groups
GroupsApi getGroupsMembers GET /v3/groupsMembers Get GroupsMembers
GroupsApi postGroups POST /v3/groups Post Groups
GroupsApi postGroupsMembers POST /v3/groupsMembers Post GroupsMembers
MeasurementsApi deleteMeasurement DELETE /v3/measurements/delete Delete a measurement
MeasurementsApi getMeasurements GET /v3/measurements Get measurements for this user
MeasurementsApi getPairs GET /v3/pairs Get pairs of measurements for correlational analysis
MeasurementsApi measurementExportRequest POST /v2/measurements/exportRequest Post Request for Measurements CSV
MeasurementsApi postMeasurements POST /v3/measurements/post Post a new set or update existing measurements to the database
MeasurementsApi updateMeasurement POST /v3/measurements/update Update a measurement
MessagesApi getMessagesMessages GET /v3/messagesMessages Get MessagesMessages
MessagesApi getMessagesNotices GET /v3/messagesNotices Get MessagesNotices
MessagesApi getMessagesRecipients GET /v3/messagesRecipients Get MessagesRecipients
MessagesApi postMessagesMessages POST /v3/messagesMessages Post MessagesMessages
MessagesApi postMessagesNotices POST /v3/messagesNotices Post MessagesNotices
MessagesApi postMessagesRecipients POST /v3/messagesRecipients Post MessagesRecipients
NotificationsApi getNotificationPreferences GET /v3/notificationPreferences Get NotificationPreferences
NotificationsApi getNotifications GET /v3/notifications Get Notifications
NotificationsApi postDeviceToken POST /v3/deviceTokens Post DeviceTokens
NotificationsApi postNotifications POST /v3/notifications Post Notifications
RemindersApi deleteTrackingReminder DELETE /v3/trackingReminders/delete Delete Tracking Reminder
RemindersApi getTrackingReminderNotifications GET /v3/trackingReminderNotifications Get specific tracking reminder notifications
RemindersApi getTrackingReminders GET /v3/trackingReminders Get repeating tracking reminder settings
RemindersApi postTrackingReminderNotifications POST /v3/trackingReminderNotifications Snooze, skip, or track a tracking reminder notification
RemindersApi postTrackingReminders POST /v3/trackingReminders Store a Tracking Reminder
SharesApi deleteShare POST /v3/shares/delete Delete share
SharesApi getShares GET /v3/shares Get Authorized Apps, Studies, and Individuals
SharesApi inviteShare POST /v3/shares/invite Delete share
StudiesApi createStudy POST /v3/study/create Create a Study
StudiesApi deleteVote DELETE /v3/votes/delete Delete vote
StudiesApi getOpenStudies GET /v3/studies/open These are open studies that anyone can join
StudiesApi getStudies GET /v3/studies Get Personal or Population Studies
StudiesApi getStudiesCreated GET /v3/studies/created Get studies you have created
StudiesApi getStudiesJoined GET /v3/studies/joined Studies You Have Joined
StudiesApi getStudy GET /v4/study Get Study
StudiesApi joinStudy POST /v3/study/join Join a Study
StudiesApi postVote POST /v3/votes Post or update vote
StudiesApi publishStudy POST /v3/study/publish Publish Your Study
UnitsApi getUnitCategories GET /v3/unitCategories Get unit categories
UnitsApi getUnits GET /v3/units Get units
UserApi deleteUser DELETE /v3/user/delete Delete user
UserApi getUser GET /v3/user Get user info
UserApi getUserBlogs GET /v3/userBlogs Get UserBlogs
UserApi postUserBlogs POST /v3/userBlogs Post UserBlogs
UserApi postUserSettings POST /v3/userSettings Post UserSettings
VariablesApi deleteUserTag DELETE /v3/userTags/delete Delete user tag or ingredient
VariablesApi deleteUserVariable DELETE /v3/userVariables/delete Delete All Measurements For Variable
VariablesApi getVariableCategories GET /v3/variableCategories Variable categories
VariablesApi getVariables GET /v3/variables Get variables along with related user-specific analysis settings and statistics
VariablesApi postUserTags POST /v3/userTags Post or update user tags or ingredients
VariablesApi postUserVariables POST /v3/variables Update User Settings for a Variable
VariablesApi resetUserVariableSettings POST /v3/userVariables/reset Reset user settings for a variable to defaults
XprofileApi getXprofileData GET /v3/xprofileData Get XprofileData
XprofileApi getXprofileFields GET /v3/xprofileFields Get XprofileFields
XprofileApi getXprofileGroups GET /v3/xprofileGroups Get XprofileGroups
XprofileApi postXprofileData POST /v3/xprofileData Post XprofileData
XprofileApi postXprofileFields POST /v3/xprofileFields Post XprofileFields
XprofileApi postXprofileGroups POST /v3/xprofileGroups Post XprofileGroups

Documentation For Models

Documentation For Authorization

access_token

  • Type: API key
  • API key parameter name: access_token
  • Location: URL query string

client_id

  • Type: API key
  • API key parameter name: clientId
  • Location: URL query string

quantimodo_oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://app.quantimo.do/api/v2/oauth/authorize
  • Scopes:
  • basic: Allows you to read user info (display name, email, etc)
  • readmeasurements: Allows one to read a user's measurements
  • writemeasurements: Allows you to write user measurements

Author