Skip to content

Files

Latest commit

 

History

History
4933 lines (3418 loc) · 148 KB

AnalyticsApi.md

File metadata and controls

4933 lines (3418 loc) · 148 KB

OpenAPI\Client\AnalyticsApi

All URIs are relative to https://api.wall.et, except if the operation defines another base path.

Method HTTP request Description
countAllSubscribers() GET /v2/analytics/sms/all/subscribers/count Count opt in list subscribers
countAuthenticatedSessions() GET /v2/analytics/walletPageViews/sessions/count/distinct/authenticated Count authenticated sessions
countDistinctRedemptions() GET /v2/analytics/ledger/paymentObject/distinct/count Fetch refund amount of campaigns by Campaign
countHelpDeskRequests() GET /v2/analytics/helpdeskrequests/count Count help desk requests by date
countInboundMessages() GET /v2/analytics/sms/inbound/count Count opt in list subscribers
countNewSessions() GET /v2/analytics/walletPageViews/sessions/count/distinct/first Count new sessions
countOptInListSubscribersPartitionedByDate() GET /v2/analytics/sms/all/subscribers/count/date Count opt in list subscribers by date
countOutboundMessages() GET /v2/analytics/sms/outbound/count Count opt in list subscribers
countTotalSessions() GET /v2/analytics/walletPageViews/sessions/count/distinct Count total sessions
countTransactions() GET /v2/analytics/ledger/transactions/count Fetch refund amount of campaigns by Campaign
countVerifiedWalletPageViews() GET /v2/analytics/walletPageViews/sessions/verified/distinct/walletObjectsCount Fetch wallet object counts within a given time frame that have a valid phone verification token
countWalletPageViews() GET /v2/analytics/walletPageViews/sessions/distinct/walletObjectsCount Fetch wallet object counts within a given time frame
exitLinkSummary() GET /v2/analytics/walletPageViews/exitLinkSummary Count exit clicks
fetchAnalyticsAdCreditsCountPartitionedByEmployee() GET /v2/analytics/advertisementCredits/count/employee Count ad credits by employee
fetchAnalyticsAdCreditsCountPartitionedByPaymentDesign() GET /v2/analytics/advertisementCredits/count/paymentDesign Count ad credits by payment design
fetchAnalyticsAdCreditsCountPartitionedByValueType() GET /v2/analytics/advertisementCredits/count/valueType Count ad credits by value type
fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByAdCreditID() GET /v2/analytics/advertisementCredits/redemptions/amount/adCredit Fetch redemption amount of ad credits by Ad Credit
fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByDate() GET /v2/analytics/advertisementCredits/redemptions/amount/date Fetch redemption amount of ad credits by date
fetchAnalyticsAdCreditsRedemptionsCountPartitionedByAdCreditID() GET /v2/analytics/advertisementCredits/redemptions/count/adCredit Count redemptions of ad credits by Ad Credit
fetchAnalyticsAdCreditsRedemptionsCountPartitionedByDate() GET /v2/analytics/advertisementCredits/redemptions/count/date Count redemptions of ad credits by date
fetchAnalyticsAdCreditsRefundsAmountPartitionedByAdCreditID() GET /v2/analytics/advertisementCredits/refunds/amount/adCredit Fetch refund amount of ad credits by Ad Credit
fetchAnalyticsAdCreditsRefundsAmountPartitionedByDate() GET /v2/analytics/advertisementCredits/refunds/amount/date Fetch refund amount of ad credits by date
fetchAnalyticsAdCreditsRefundsCountPartitionedByAdCreditID() GET /v2/analytics/advertisementCredits/refunds/count/adCredit Count refunds of ad credits by Ad Credit
fetchAnalyticsAdCreditsRefundsCountPartitionedByDate() GET /v2/analytics/advertisementCredits/refunds/count/date Count refunds of ad credits by date
fetchAnalyticsAdCreditsScansCountPartitionedByAdCreditID() GET /v2/analytics/advertisementCredits/scans/count/adCredit Count scans of ad credits by Ad Credit
fetchAnalyticsAdCreditsScansCountPartitionedByDate() GET /v2/analytics/advertisementCredits/scans/count/date Count scans of ad credits by date
fetchAnalyticsCampaignWalletPageViews() GET /v2/analytics/walletPageViews/campaign/{campaignID} Fetch a campaign's wallet page views
fetchAnalyticsCampaignsCountPartitionedByCampaignID() GET /v2/analytics/campaigns/count/campaign/created Count created campaigns by campaign
fetchAnalyticsCampaignsCountPartitionedByEmployee() GET /v2/analytics/campaigns/count/employee Count campaigns by employee
fetchAnalyticsCampaignsCountPartitionedByPaymentDesign() GET /v2/analytics/campaigns/count/paymentDesign Count campaigns by payment design
fetchAnalyticsCampaignsCountPartitionedByValueType() GET /v2/analytics/campaigns/count/valueType Count campaigns by value type
fetchAnalyticsCampaignsRedemptionsAmountPartitionedByCampaignID() GET /v2/analytics/campaigns/redemptions/amount/campaign Fetch redemption amount of campaigns by Campaign
fetchAnalyticsCampaignsRedemptionsAmountPartitionedByDate() GET /v2/analytics/campaigns/redemptions/amount/date Fetch redemption amount of campaigns by date
fetchAnalyticsCampaignsRedemptionsCountPartitionedByCampaignID() GET /v2/analytics/campaigns/redemptions/count/campaign Count redemptions of campaigns by Campaign
fetchAnalyticsCampaignsRedemptionsCountPartitionedByDate() GET /v2/analytics/campaigns/redemptions/count/date Count redemptions of campaigns by date
fetchAnalyticsCampaignsRefundsAmountPartitionedByCampaignID() GET /v2/analytics/campaigns/refunds/amount/campaign Fetch refund amount of campaigns by Campaign
fetchAnalyticsCampaignsRefundsAmountPartitionedByDate() GET /v2/analytics/campaigns/refunds/amount/date Fetch refund amount of campaigns by date
fetchAnalyticsCampaignsRefundsCountPartitionedByCampaignID() GET /v2/analytics/campaigns/refunds/count/campaign Fetch refund amount of campaigns by Campaign
fetchAnalyticsCampaignsRefundsCountPartitionedByDate() GET /v2/analytics/campaigns/refunds/count/date Fetch refund amount of campaigns by date
fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByDate() GET /v2/analytics/outboundSMS/count/date/delivered Count delivered outbound messages by date
fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByPhoneNumber() GET /v2/analytics/outboundSMS/count/phoneNumber/delivered Count delivered outbound messages by phone number
fetchAnalyticsDistinctWalletSessions() GET /v2/analytics/walletPageViews/sessions/distinct Fetch distinct wallet sessions
fetchAnalyticsDynamicVouchersCountPartitionedByEmployee() GET /v2/analytics/dynamicVouchers/count/employee Count dynamic vouchers by employee
fetchAnalyticsDynamicVouchersCountPartitionedByPaymentDesign() GET /v2/analytics/dynamicVouchers/count/paymentDesign Count dynamic vouchers by payment design
fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDate() GET /v2/analytics/dynamicVouchers/redemptions/amount/date Fetch redemption amount of dynamic vouchers by date
fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDynamicVoucherID() GET /v2/analytics/dynamicVouchers/redemptions/amount/dynamicVoucher Fetch redemption amount of dynamic vouchers by dynamic voucher
fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDate() GET /v2/analytics/dynamicVouchers/redemptions/count/date Count redemptions of dynamic vouchers by date
fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDynamicVoucherID() GET /v2/analytics/dynamicVouchers/redemptions/count/dynamicVoucher Count redemptions of dynamic vouchers by dynamic voucher
fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDate() GET /v2/analytics/dynamicVouchers/refunds/amount/date Fetch refund amount of dynamic vouchers by date
fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDynamicVoucherID() GET /v2/analytics/dynamicVouchers/refunds/amount/dynamicVoucher Fetch refund amount of dynamic vouchers by dynamic voucher
fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDate() GET /v2/analytics/dynamicVouchers/refunds/count/date Count refunds of dynamic vouchers by date
fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDynamicVoucherID() GET /v2/analytics/dynamicVouchers/refunds/count/dynamicVoucher Count refunds of dynamic vouchers by dynamic voucher
fetchAnalyticsHelpDeskRequestsCreatedCountPartitionedByDate() GET /v2/analytics/helpdeskrequests/count/date/created Count help desk requests by date
fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByDate() GET /v2/analytics/helpdeskrequests/count/date/resolved Count resolved help desk requests by date
fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByEmployee() GET /v2/analytics/helpdeskrequests/count/employee/resolved Count resolved help desk requests by employee
fetchAnalyticsHelpDeskRequestsUnresolvedCountPartitionedByDate() GET /v2/analytics/helpdeskrequests/count/date/unresolved Count unresolved help desk requests by date
fetchAnalyticsItemWalletPageViews() GET /v2/analytics/walletPageViews/item/{itemID} Fetch wallet page views of item
fetchAnalyticsMemberCount() GET /v2/analytics/membership/member/count Count members
fetchAnalyticsMerchantCreditCount() GET /v2/analytics/membership/merchantCredit/count Count merchant credits
fetchAnalyticsOfferVsRedeemedAmountPartitionedByCampaignID() GET /v2/analytics/campaigns/amount/campaign/offerVsRedeemed Fetch offer vs redeemed amount by campaign
fetchAnalyticsPaymentObjectBroadcastsCreatedCountPartitionedByDate() GET /v2/analytics/paymentObjectBroadcasts/count/date/created Count created broadcasts by date
fetchAnalyticsPaymentObjectBroadcastsIndividualExecutionTimeOfCompletedBroadcasts() GET /v2/analytics/paymentObjectBroadcasts/executionTime/completed Fetch execution time of completed broadcasts
fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByDate() GET /v2/analytics/paymentObjectBroadcasts/count/date/scheduled Count scheduled broadcasts by date
fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByEmployee() GET /v2/analytics/paymentObjectBroadcasts/count/employee/scheduled Count scheduled broadcasts by employee
fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByPhoneNumber() GET /v2/analytics/paymentObjectBroadcasts/count/phoneNumber/scheduled Count scheduled broadcasts by phone number
fetchAnalyticsPaymentObjectBroadcastsScheduledSMSCountPartitionedByDate() GET /v2/analytics/paymentObjectBroadcasts/sms/count/date/scheduled Count scheduled SMS broadcasts by date
fetchAnalyticsSentOutboundMessagesCountPartitionedByDate() GET /v2/analytics/outboundSMS/count/date/sent Count sent outbound messages by date
fetchAnalyticsSentOutboundMessagesCountPartitionedByPhoneNumber() GET /v2/analytics/outboundSMS/count/phoneNumber/sent Count sent outbound messages by phone number
fetchAnalyticsStaticVoucherWalletPageViews() GET /v2/analytics/walletPageViews/staticVoucher/{voucherID} Fetch a static voucher's wallet page views
fetchAnalyticsTCPAFiltersCreateCountPartitionedByDate() GET /v2/analytics/tcpafilters/count/date/create Count created TCPA Filter entries by date
fetchAnalyticsTCPAFiltersDeleteCountPartitionedByDate() GET /v2/analytics/tcpafilters/count/date/delete Count deleted TCPA Filter entries by date
fetchAnalyticsTCPAStopCountPartitionedByDate() GET /v2/analytics/tcpa/count/date/stop Count TCPA (STOP) entries by date
fetchAnalyticsTCPAStopCountPartitionedByPhoneNumber() GET /v2/analytics/tcpa/count/phoneNumber/stop Count TCPA (STOP) entries by phone number
fetchAnalyticsTotalAmountRedeemedPerMerchantCredit() GET /v2/analytics/membership/merchantCredit/amount/redeemed Fetch redeemed amount of merchant credits
fetchAnalyticsTotalAmountRedeemedPerTier() GET /v2/analytics/membership/tier/amount/redeemed Fetch redeemed amoun̥t of tiers
fetchAnalyticsTotalAmountRefundedPerMerchantCredit() GET /v2/analytics/membership/merchantCredit/amount/refunded Fetch refunded amount of merchant credits
fetchAnalyticsTotalAmountRefundedPerTier() GET /v2/analytics/membership/tier/amount/refunded Fetch refunded amount of tiers
fetchAnalyticsTotalPointsRedeemed() GET /v2/analytics/membership/member/points/redeemed Count redeemed points
fetchAnalyticsTotalPointsRefunded() GET /v2/analytics/membership/member/points/refunded Count refunded points
fetchAnalyticsWalletSessionActivity() GET /v2/analytics/walletPageViews/session/activity/{sessionID} Fetch session activity
fetchWalletPageViewByID() GET /v2/analytics/walletPageViews/activity/{id} Fetch session activity by wallet page view ID
referringSitesSummary() GET /v2/analytics/walletPageViews/referringSitesSummary Count referring sites
sumRevenue() GET /v2/analytics/ledger/revenue/sum Fetch refund amount of campaigns by Campaign
sumTransactions() GET /v2/analytics/ledger/transactions/sum Fetch refund amount of campaigns by Campaign

countAllSubscribers()

countAllSubscribers($is_subscribed, $is_pending_age21_verification, $is_archive_included, $start_date, $end_date): \OpenAPI\Client\Model\WTCountResult

Count opt in list subscribers

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$is_subscribed = True; // bool
$is_pending_age21_verification = True; // bool
$is_archive_included = True; // bool
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->countAllSubscribers($is_subscribed, $is_pending_age21_verification, $is_archive_included, $start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countAllSubscribers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
is_subscribed bool [optional]
is_pending_age21_verification bool [optional]
is_archive_included bool [optional]
start_date \DateTime [optional]
end_date \DateTime [optional]

Return type

\OpenAPI\Client\Model\WTCountResult

Authorization

No authorization required

HTTP request headers

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

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

countAuthenticatedSessions()

countAuthenticatedSessions($start_date, $end_date): mixed

Count authenticated sessions

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->countAuthenticatedSessions($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countAuthenticatedSessions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime [optional]
end_date \DateTime [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

countDistinctRedemptions()

countDistinctRedemptions($start_date, $end_date, $transaction_type, $segment_type): mixed

Fetch refund amount of campaigns by Campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$transaction_type = 'transaction_type_example'; // string
$segment_type = 'segment_type_example'; // string

try {
    $result = $apiInstance->countDistinctRedemptions($start_date, $end_date, $transaction_type, $segment_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countDistinctRedemptions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
transaction_type string [optional]
segment_type string [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

countHelpDeskRequests()

countHelpDeskRequests($start_date, $end_date, $locale, $timezone, $is_resolved): mixed

Count help desk requests by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string
$is_resolved = True; // bool

try {
    $result = $apiInstance->countHelpDeskRequests($start_date, $end_date, $locale, $timezone, $is_resolved);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countHelpDeskRequests: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string
is_resolved bool [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

countInboundMessages()

countInboundMessages($start_date, $end_date): \OpenAPI\Client\Model\WTCountResult

Count opt in list subscribers

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->countInboundMessages($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countInboundMessages: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime [optional]
end_date \DateTime [optional]

Return type

\OpenAPI\Client\Model\WTCountResult

Authorization

No authorization required

HTTP request headers

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

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

countNewSessions()

countNewSessions($start_date, $end_date): mixed

Count new sessions

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->countNewSessions($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countNewSessions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime [optional]
end_date \DateTime [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

countOptInListSubscribersPartitionedByDate()

countOptInListSubscribersPartitionedByDate($start_date, $end_date): mixed

Count opt in list subscribers by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->countOptInListSubscribersPartitionedByDate($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countOptInListSubscribersPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

countOutboundMessages()

countOutboundMessages($start_date, $end_date): \OpenAPI\Client\Model\WTCountResult

Count opt in list subscribers

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->countOutboundMessages($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countOutboundMessages: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime [optional]
end_date \DateTime [optional]

Return type

\OpenAPI\Client\Model\WTCountResult

Authorization

No authorization required

HTTP request headers

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

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

countTotalSessions()

countTotalSessions($start_date, $end_date): mixed

Count total sessions

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->countTotalSessions($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countTotalSessions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime [optional]
end_date \DateTime [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

countTransactions()

countTransactions($start_date, $end_date, $transaction_type, $segment_type): mixed

Fetch refund amount of campaigns by Campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$transaction_type = 'transaction_type_example'; // string
$segment_type = 'segment_type_example'; // string

try {
    $result = $apiInstance->countTransactions($start_date, $end_date, $transaction_type, $segment_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countTransactions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
transaction_type string [optional]
segment_type string [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

countVerifiedWalletPageViews()

countVerifiedWalletPageViews($start_date, $end_date): \OpenAPI\Client\Model\WTWalletObjectPrefixCounts[]

Fetch wallet object counts within a given time frame that have a valid phone verification token

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->countVerifiedWalletPageViews($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countVerifiedWalletPageViews: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

\OpenAPI\Client\Model\WTWalletObjectPrefixCounts[]

Authorization

No authorization required

HTTP request headers

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

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

countWalletPageViews()

countWalletPageViews($start_date, $end_date): \OpenAPI\Client\Model\WTWalletObjectPrefixCounts[]

Fetch wallet object counts within a given time frame

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->countWalletPageViews($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->countWalletPageViews: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

\OpenAPI\Client\Model\WTWalletObjectPrefixCounts[]

Authorization

No authorization required

HTTP request headers

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

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

exitLinkSummary()

exitLinkSummary($start_date, $end_date): mixed

Count exit clicks

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->exitLinkSummary($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->exitLinkSummary: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime [optional]
end_date \DateTime [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsCountPartitionedByEmployee()

fetchAnalyticsAdCreditsCountPartitionedByEmployee($start_date, $end_date): mixed[]

Count ad credits by employee

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsCountPartitionedByEmployee($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsCountPartitionedByEmployee: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsCountPartitionedByPaymentDesign()

fetchAnalyticsAdCreditsCountPartitionedByPaymentDesign($start_date, $end_date): mixed[]

Count ad credits by payment design

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsCountPartitionedByPaymentDesign($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsCountPartitionedByPaymentDesign: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsCountPartitionedByValueType()

fetchAnalyticsAdCreditsCountPartitionedByValueType($start_date, $end_date): mixed

Count ad credits by value type

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsCountPartitionedByValueType($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsCountPartitionedByValueType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByAdCreditID()

fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByAdCreditID($start_date, $end_date): mixed[]

Fetch redemption amount of ad credits by Ad Credit

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByAdCreditID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByAdCreditID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByDate()

fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Fetch redemption amount of ad credits by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsRedemptionsAmountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsRedemptionsCountPartitionedByAdCreditID()

fetchAnalyticsAdCreditsRedemptionsCountPartitionedByAdCreditID($start_date, $end_date): mixed[]

Count redemptions of ad credits by Ad Credit

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsRedemptionsCountPartitionedByAdCreditID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsRedemptionsCountPartitionedByAdCreditID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsRedemptionsCountPartitionedByDate()

fetchAnalyticsAdCreditsRedemptionsCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count redemptions of ad credits by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsRedemptionsCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsRedemptionsCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsRefundsAmountPartitionedByAdCreditID()

fetchAnalyticsAdCreditsRefundsAmountPartitionedByAdCreditID($start_date, $end_date): mixed[]

Fetch refund amount of ad credits by Ad Credit

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsRefundsAmountPartitionedByAdCreditID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsRefundsAmountPartitionedByAdCreditID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsRefundsAmountPartitionedByDate()

fetchAnalyticsAdCreditsRefundsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Fetch refund amount of ad credits by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsRefundsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsRefundsAmountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsRefundsCountPartitionedByAdCreditID()

fetchAnalyticsAdCreditsRefundsCountPartitionedByAdCreditID($start_date, $end_date): mixed[]

Count refunds of ad credits by Ad Credit

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsRefundsCountPartitionedByAdCreditID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsRefundsCountPartitionedByAdCreditID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsRefundsCountPartitionedByDate()

fetchAnalyticsAdCreditsRefundsCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count refunds of ad credits by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsRefundsCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsRefundsCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsScansCountPartitionedByAdCreditID()

fetchAnalyticsAdCreditsScansCountPartitionedByAdCreditID($start_date, $end_date): mixed[]

Count scans of ad credits by Ad Credit

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsScansCountPartitionedByAdCreditID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsScansCountPartitionedByAdCreditID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsAdCreditsScansCountPartitionedByDate()

fetchAnalyticsAdCreditsScansCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count scans of ad credits by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsAdCreditsScansCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsAdCreditsScansCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignWalletPageViews()

fetchAnalyticsCampaignWalletPageViews($campaign_id): \OpenAPI\Client\Model\WTWalletPageView[]

Fetch a campaign's wallet page views

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$campaign_id = NULL; // mixed

try {
    $result = $apiInstance->fetchAnalyticsCampaignWalletPageViews($campaign_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignWalletPageViews: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
campaign_id mixed

Return type

\OpenAPI\Client\Model\WTWalletPageView[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsCountPartitionedByCampaignID()

fetchAnalyticsCampaignsCountPartitionedByCampaignID($start_date, $end_date): mixed[]

Count created campaigns by campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsCampaignsCountPartitionedByCampaignID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsCountPartitionedByCampaignID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsCountPartitionedByEmployee()

fetchAnalyticsCampaignsCountPartitionedByEmployee($start_date, $end_date): mixed[]

Count campaigns by employee

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsCampaignsCountPartitionedByEmployee($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsCountPartitionedByEmployee: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsCountPartitionedByPaymentDesign()

fetchAnalyticsCampaignsCountPartitionedByPaymentDesign($start_date, $end_date): mixed[]

Count campaigns by payment design

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsCampaignsCountPartitionedByPaymentDesign($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsCountPartitionedByPaymentDesign: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsCountPartitionedByValueType()

fetchAnalyticsCampaignsCountPartitionedByValueType($start_date, $end_date): mixed

Count campaigns by value type

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsCampaignsCountPartitionedByValueType($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsCountPartitionedByValueType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsRedemptionsAmountPartitionedByCampaignID()

fetchAnalyticsCampaignsRedemptionsAmountPartitionedByCampaignID($start_date, $end_date): mixed[]

Fetch redemption amount of campaigns by Campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsCampaignsRedemptionsAmountPartitionedByCampaignID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsRedemptionsAmountPartitionedByCampaignID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsRedemptionsAmountPartitionedByDate()

fetchAnalyticsCampaignsRedemptionsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Fetch redemption amount of campaigns by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsCampaignsRedemptionsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsRedemptionsAmountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsRedemptionsCountPartitionedByCampaignID()

fetchAnalyticsCampaignsRedemptionsCountPartitionedByCampaignID($start_date, $end_date): mixed[]

Count redemptions of campaigns by Campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsCampaignsRedemptionsCountPartitionedByCampaignID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsRedemptionsCountPartitionedByCampaignID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsRedemptionsCountPartitionedByDate()

fetchAnalyticsCampaignsRedemptionsCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count redemptions of campaigns by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsCampaignsRedemptionsCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsRedemptionsCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsRefundsAmountPartitionedByCampaignID()

fetchAnalyticsCampaignsRefundsAmountPartitionedByCampaignID($start_date, $end_date): mixed[]

Fetch refund amount of campaigns by Campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsCampaignsRefundsAmountPartitionedByCampaignID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsRefundsAmountPartitionedByCampaignID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsRefundsAmountPartitionedByDate()

fetchAnalyticsCampaignsRefundsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Fetch refund amount of campaigns by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsCampaignsRefundsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsRefundsAmountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsRefundsCountPartitionedByCampaignID()

fetchAnalyticsCampaignsRefundsCountPartitionedByCampaignID($start_date, $end_date): mixed[]

Fetch refund amount of campaigns by Campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsCampaignsRefundsCountPartitionedByCampaignID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsRefundsCountPartitionedByCampaignID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsCampaignsRefundsCountPartitionedByDate()

fetchAnalyticsCampaignsRefundsCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Fetch refund amount of campaigns by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsCampaignsRefundsCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsCampaignsRefundsCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByDate()

fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count delivered outbound messages by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByPhoneNumber()

fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByPhoneNumber($start_date, $end_date): mixed[]

Count delivered outbound messages by phone number

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByPhoneNumber($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDeliveredOutboundMessagesCountPartitionedByPhoneNumber: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDistinctWalletSessions()

fetchAnalyticsDistinctWalletSessions($start_date, $end_date): mixed

Fetch distinct wallet sessions

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsDistinctWalletSessions($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDistinctWalletSessions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime [optional]
end_date \DateTime [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersCountPartitionedByEmployee()

fetchAnalyticsDynamicVouchersCountPartitionedByEmployee($start_date, $end_date): mixed[]

Count dynamic vouchers by employee

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersCountPartitionedByEmployee($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersCountPartitionedByEmployee: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersCountPartitionedByPaymentDesign()

fetchAnalyticsDynamicVouchersCountPartitionedByPaymentDesign($start_date, $end_date): mixed[]

Count dynamic vouchers by payment design

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersCountPartitionedByPaymentDesign($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersCountPartitionedByPaymentDesign: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDate()

fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Fetch redemption amount of dynamic vouchers by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDynamicVoucherID()

fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDynamicVoucherID($start_date, $end_date): mixed[]

Fetch redemption amount of dynamic vouchers by dynamic voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDynamicVoucherID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersRedemptionsAmountPartitionedByDynamicVoucherID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDate()

fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed[]

Count redemptions of dynamic vouchers by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDynamicVoucherID()

fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDynamicVoucherID($start_date, $end_date): mixed[]

Count redemptions of dynamic vouchers by dynamic voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDynamicVoucherID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersRedemptionsCountPartitionedByDynamicVoucherID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDate()

fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Fetch refund amount of dynamic vouchers by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDynamicVoucherID()

fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDynamicVoucherID($start_date, $end_date): mixed[]

Fetch refund amount of dynamic vouchers by dynamic voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDynamicVoucherID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersRefundsAmountPartitionedByDynamicVoucherID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDate()

fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count refunds of dynamic vouchers by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDynamicVoucherID()

fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDynamicVoucherID($start_date, $end_date): mixed[]

Count refunds of dynamic vouchers by dynamic voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDynamicVoucherID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsDynamicVouchersRefundsCountPartitionedByDynamicVoucherID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsHelpDeskRequestsCreatedCountPartitionedByDate()

fetchAnalyticsHelpDeskRequestsCreatedCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count help desk requests by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsHelpDeskRequestsCreatedCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsHelpDeskRequestsCreatedCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByDate()

fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count resolved help desk requests by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByEmployee()

fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByEmployee($start_date, $end_date): mixed[]

Count resolved help desk requests by employee

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByEmployee($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsHelpDeskRequestsResolvedCountPartitionedByEmployee: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsHelpDeskRequestsUnresolvedCountPartitionedByDate()

fetchAnalyticsHelpDeskRequestsUnresolvedCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count unresolved help desk requests by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsHelpDeskRequestsUnresolvedCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsHelpDeskRequestsUnresolvedCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsItemWalletPageViews()

fetchAnalyticsItemWalletPageViews($item_id): mixed

Fetch wallet page views of item

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$item_id = 'item_id_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsItemWalletPageViews($item_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsItemWalletPageViews: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
item_id string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsMemberCount()

fetchAnalyticsMemberCount($start_date, $end_date, $locale, $timezone): \OpenAPI\Client\Model\MSAnalyticsMemberCountPartitionedByDate[]

Count members

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsMemberCount($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsMemberCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

\OpenAPI\Client\Model\MSAnalyticsMemberCountPartitionedByDate[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsMerchantCreditCount()

fetchAnalyticsMerchantCreditCount($start_date, $end_date, $locale, $timezone): mixed

Count merchant credits

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsMerchantCreditCount($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsMerchantCreditCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsOfferVsRedeemedAmountPartitionedByCampaignID()

fetchAnalyticsOfferVsRedeemedAmountPartitionedByCampaignID($start_date, $end_date): mixed[]

Fetch offer vs redeemed amount by campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsOfferVsRedeemedAmountPartitionedByCampaignID($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsOfferVsRedeemedAmountPartitionedByCampaignID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsPaymentObjectBroadcastsCreatedCountPartitionedByDate()

fetchAnalyticsPaymentObjectBroadcastsCreatedCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count created broadcasts by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsPaymentObjectBroadcastsCreatedCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsPaymentObjectBroadcastsCreatedCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsPaymentObjectBroadcastsIndividualExecutionTimeOfCompletedBroadcasts()

fetchAnalyticsPaymentObjectBroadcastsIndividualExecutionTimeOfCompletedBroadcasts($start_date, $end_date): mixed

Fetch execution time of completed broadcasts

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsPaymentObjectBroadcastsIndividualExecutionTimeOfCompletedBroadcasts($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsPaymentObjectBroadcastsIndividualExecutionTimeOfCompletedBroadcasts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByDate()

fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count scheduled broadcasts by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByEmployee()

fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByEmployee($start_date, $end_date): mixed[]

Count scheduled broadcasts by employee

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByEmployee($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByEmployee: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByPhoneNumber()

fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByPhoneNumber($start_date, $end_date): mixed[]

Count scheduled broadcasts by phone number

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByPhoneNumber($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsPaymentObjectBroadcastsScheduledCountPartitionedByPhoneNumber: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsPaymentObjectBroadcastsScheduledSMSCountPartitionedByDate()

fetchAnalyticsPaymentObjectBroadcastsScheduledSMSCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count scheduled SMS broadcasts by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsPaymentObjectBroadcastsScheduledSMSCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsPaymentObjectBroadcastsScheduledSMSCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsSentOutboundMessagesCountPartitionedByDate()

fetchAnalyticsSentOutboundMessagesCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count sent outbound messages by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsSentOutboundMessagesCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsSentOutboundMessagesCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsSentOutboundMessagesCountPartitionedByPhoneNumber()

fetchAnalyticsSentOutboundMessagesCountPartitionedByPhoneNumber($start_date, $end_date): mixed[]

Count sent outbound messages by phone number

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsSentOutboundMessagesCountPartitionedByPhoneNumber($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsSentOutboundMessagesCountPartitionedByPhoneNumber: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsStaticVoucherWalletPageViews()

fetchAnalyticsStaticVoucherWalletPageViews($voucher_id): \OpenAPI\Client\Model\WTWalletPageView[]

Fetch a static voucher's wallet page views

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$voucher_id = NULL; // mixed

try {
    $result = $apiInstance->fetchAnalyticsStaticVoucherWalletPageViews($voucher_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsStaticVoucherWalletPageViews: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
voucher_id mixed

Return type

\OpenAPI\Client\Model\WTWalletPageView[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTCPAFiltersCreateCountPartitionedByDate()

fetchAnalyticsTCPAFiltersCreateCountPartitionedByDate($start_date, $end_date): mixed

Count created TCPA Filter entries by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsTCPAFiltersCreateCountPartitionedByDate($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTCPAFiltersCreateCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTCPAFiltersDeleteCountPartitionedByDate()

fetchAnalyticsTCPAFiltersDeleteCountPartitionedByDate($start_date, $end_date): mixed

Count deleted TCPA Filter entries by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsTCPAFiltersDeleteCountPartitionedByDate($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTCPAFiltersDeleteCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTCPAStopCountPartitionedByDate()

fetchAnalyticsTCPAStopCountPartitionedByDate($start_date, $end_date, $locale, $timezone): mixed

Count TCPA (STOP) entries by date

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsTCPAStopCountPartitionedByDate($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTCPAStopCountPartitionedByDate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTCPAStopCountPartitionedByPhoneNumber()

fetchAnalyticsTCPAStopCountPartitionedByPhoneNumber($start_date, $end_date): mixed[]

Count TCPA (STOP) entries by phone number

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchAnalyticsTCPAStopCountPartitionedByPhoneNumber($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTCPAStopCountPartitionedByPhoneNumber: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTotalAmountRedeemedPerMerchantCredit()

fetchAnalyticsTotalAmountRedeemedPerMerchantCredit($start_date, $end_date, $locale, $timezone): mixed

Fetch redeemed amount of merchant credits

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsTotalAmountRedeemedPerMerchantCredit($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTotalAmountRedeemedPerMerchantCredit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTotalAmountRedeemedPerTier()

fetchAnalyticsTotalAmountRedeemedPerTier($start_date, $end_date, $locale, $timezone): \OpenAPI\Client\Model\MSAnalyticsMembershipTierAmountRedeemedPartitionedByDate[]

Fetch redeemed amoun̥t of tiers

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsTotalAmountRedeemedPerTier($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTotalAmountRedeemedPerTier: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

\OpenAPI\Client\Model\MSAnalyticsMembershipTierAmountRedeemedPartitionedByDate[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTotalAmountRefundedPerMerchantCredit()

fetchAnalyticsTotalAmountRefundedPerMerchantCredit($start_date, $end_date, $locale, $timezone): mixed

Fetch refunded amount of merchant credits

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsTotalAmountRefundedPerMerchantCredit($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTotalAmountRefundedPerMerchantCredit: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTotalAmountRefundedPerTier()

fetchAnalyticsTotalAmountRefundedPerTier($start_date, $end_date, $locale, $timezone): \OpenAPI\Client\Model\MSAnalyticsMembershipTierAmountRefundedPartitionedByDate[]

Fetch refunded amount of tiers

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsTotalAmountRefundedPerTier($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTotalAmountRefundedPerTier: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

\OpenAPI\Client\Model\MSAnalyticsMembershipTierAmountRefundedPartitionedByDate[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTotalPointsRedeemed()

fetchAnalyticsTotalPointsRedeemed($start_date, $end_date, $locale, $timezone): \OpenAPI\Client\Model\MSAnalyticsMemberPointsRedeemedPartitionedByDate[]

Count redeemed points

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsTotalPointsRedeemed($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTotalPointsRedeemed: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

\OpenAPI\Client\Model\MSAnalyticsMemberPointsRedeemedPartitionedByDate[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsTotalPointsRefunded()

fetchAnalyticsTotalPointsRefunded($start_date, $end_date, $locale, $timezone): \OpenAPI\Client\Model\MSAnalyticsMemberPointsRefundedPartitionedByDate[]

Count refunded points

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$locale = 'locale_example'; // string
$timezone = 'timezone_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsTotalPointsRefunded($start_date, $end_date, $locale, $timezone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsTotalPointsRefunded: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
locale string
timezone string

Return type

\OpenAPI\Client\Model\MSAnalyticsMemberPointsRefundedPartitionedByDate[]

Authorization

No authorization required

HTTP request headers

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

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

fetchAnalyticsWalletSessionActivity()

fetchAnalyticsWalletSessionActivity($session_id): \OpenAPI\Client\Model\WTWalletPageView[]

Fetch session activity

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$session_id = 'session_id_example'; // string

try {
    $result = $apiInstance->fetchAnalyticsWalletSessionActivity($session_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchAnalyticsWalletSessionActivity: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
session_id string

Return type

\OpenAPI\Client\Model\WTWalletPageView[]

Authorization

No authorization required

HTTP request headers

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

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

fetchWalletPageViewByID()

fetchWalletPageViewByID($id): \OpenAPI\Client\Model\WalletPageView

Fetch session activity by wallet page view ID

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$id = 'id_example'; // string

try {
    $result = $apiInstance->fetchWalletPageViewByID($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->fetchWalletPageViewByID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string

Return type

\OpenAPI\Client\Model\WalletPageView

Authorization

No authorization required

HTTP request headers

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

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

referringSitesSummary()

referringSitesSummary($start_date, $end_date): mixed

Count referring sites

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->referringSitesSummary($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->referringSitesSummary: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime [optional]
end_date \DateTime [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

sumRevenue()

sumRevenue($start_date, $end_date, $transaction_type, $segment_type): mixed

Fetch refund amount of campaigns by Campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$transaction_type = 'transaction_type_example'; // string
$segment_type = 'segment_type_example'; // string

try {
    $result = $apiInstance->sumRevenue($start_date, $end_date, $transaction_type, $segment_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->sumRevenue: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
transaction_type string [optional]
segment_type string [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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

sumTransactions()

sumTransactions($start_date, $end_date, $transaction_type, $segment_type): mixed

Fetch refund amount of campaigns by Campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\AnalyticsApi(
    // 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()
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$transaction_type = 'transaction_type_example'; // string
$segment_type = 'segment_type_example'; // string

try {
    $result = $apiInstance->sumTransactions($start_date, $end_date, $transaction_type, $segment_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->sumTransactions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date \DateTime
end_date \DateTime
transaction_type string [optional]
segment_type string [optional]

Return type

mixed

Authorization

No authorization required

HTTP request headers

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

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