Skip to content

Latest commit

 

History

History
144 lines (108 loc) · 7.41 KB

FeedApi.md

File metadata and controls

144 lines (108 loc) · 7.41 KB
Raw

QuantiModo\Client\FeedApi

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

Method HTTP request Description
getFeed GET /v3/feed Tracking reminder notifications, messages, and study results
postFeed POST /v3/feed Post user interactions with feed

getFeed

\QuantiModo\Client\Model\FeedResponse getFeed($sort, $user_id, $created_at, $updated_at, $limit, $offset, $client_id, $platform)

Tracking reminder notifications, messages, and study results

Tracking reminder notifications, messages, and study results

Example

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

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

$apiInstance = new QuantiModo\Client\Api\FeedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$sort = "sort_example"; // string | Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order.
$user_id = 8.14; // float | User's id
$created_at = "created_at_example"; // string | When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
$updated_at = "updated_at_example"; // string | When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
$limit = 100; // int | The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.
$offset = 56; // int | OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.
$client_id = "client_id_example"; // string | Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do
$platform = "platform_example"; // string | Ex: chrome, android, ios, web

try {
    $result = $apiInstance->getFeed($sort, $user_id, $created_at, $updated_at, $limit, $offset, $client_id, $platform);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedApi->getFeed: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
sort string Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order. [optional]
user_id float User's id [optional]
created_at string When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local. [optional]
updated_at string When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local. [optional]
limit int The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records. [optional] [default to 100]
offset int OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned. [optional]
client_id string Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do [optional]
platform string Ex: chrome, android, ios, web [optional]

Return type

\QuantiModo\Client\Model\FeedResponse

Authorization

access_token, quantimodo_oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postFeed

\QuantiModo\Client\Model\FeedResponse postFeed($body, $user_id, $client_id, $platform)

Post user interactions with feed

Post user actions on feed cards

Example

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

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

$apiInstance = new QuantiModo\Client\Api\FeedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = array(new \QuantiModo\Client\Model\Card()); // \QuantiModo\Client\Model\Card[] | Id of the tracking reminder notification to be snoozed
$user_id = 8.14; // float | User's id
$client_id = "client_id_example"; // string | Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do
$platform = "platform_example"; // string | Ex: chrome, android, ios, web

try {
    $result = $apiInstance->postFeed($body, $user_id, $client_id, $platform);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedApi->postFeed: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \QuantiModo\Client\Model\Card[] Id of the tracking reminder notification to be snoozed
user_id float User's id [optional]
client_id string Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do [optional]
platform string Ex: chrome, android, ios, web [optional]

Return type

\QuantiModo\Client\Model\FeedResponse

Authorization

access_token, quantimodo_oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]