\Linusx\Empyr\ControllersEmpyrReport

Class EmpyrReport.

Summary

Methods

Properties

Constants

__construct()
statsReport()
txReport()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: Controllers/EmpyrReport.php
Package: Empyr
Class hierarchy: \Linusx\Empyr\Controllers\EmpyrController

\Linusx\Empyr\Controllers\EmpyrReport

Methods

__construct()

__construct(array  $data = array())

Empyr Report Methods.

Parameters

array

$data

Data to set field with.

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

statsReport()

statsReport(array  $options = array()) : boolean|mixed

Allows retrieval of various business stats.

Parameters

array

$options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

Tags

mogl

https://www.mogl.com/api/docs/v2/Reports/statsLookup

options

startDate Include stats data starting from this point.
endDate Include stats data ending from this point.
business required The business to pull the stats report for.
groupingOption required The grouping option to group the report by [DAY_OF_MONTH, MONTH_OF_YEAR].
statsTypes multi The type of stats to be pulled (implicitly results will be grouped. Options are: [FACEBOOK_POSTS, TWITTER_POSTS, EMAIL_MENTIONS, WEB_SEARCH_VIEWS, MOB_SEARCH_VIEWS, WEB_PROFILE_VIEWS, MOB_PROFILE_VIEWS, LOGIN, EMAIL_EVENT, PUSH_EVENT, SMS_EVENT, KIOSK_HEARTBEAT]
offset The offset into the results
numResults The number of results to retrieve (default 100)

txReport()

txReport(array  $options = array()) : boolean|mixed

Allows retrieval of summaries of transactional data.

Parameters

array

$options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

Tags

mogl	https://www.mogl.com/api/docs/v2/Reports/txReportLookup
options	startDate Include stats data starting from this point. endDate Include stats data ending from this point. byProcessDate Whether the start and end date are the transaction dates OR the dates that the transactions are processed. Typically, for example, with invoices you would use the process date but for dashbaords would use the transaction date. business required The business to pull the stats report for. groupingOption required The grouping option to group the report by [DAY_OF_MONTH, MONTH_OF_YEAR, GENDER, ZIPCODE, PUBLISHER_DATE]. sortingOption required The sorting option to sort the report by [GROUPED_BY_VALUE, CASHBACK, REVENUE, RECENT, MONTH_YEAR]. offset The offset into the results numResults The number of results to retrieve (default 100)
todo	Doesn't seem to be working.