Settings

addReportType(string $reportTypeName, string $displayType = "barchart") _v5

Add a report type
PARAMETERS:
$reportTypeName = string, Report type name (for chart JS)
$displayType = string, Display type name
RETURN VALUE:
void

getAddColumnArr() _v5

Gets list of report's columns as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = list of report's columns as an array

getBeginTime() _v5

Gets report start time as timestamp
PARAMETERS:
NONE
RETURN VALUE:
int = report start time as timestamp

getChartTypeArr() _v5

Gets list of chart type details
PARAMETERS:
NONE
RETURN VALUE:
Array = list of chart type details

getDataTotal() _v5

Gets total number of report data status
PARAMETERS:
NONE
RETURN VALUE:
bool = True to allow showing total number of data items | false otherwise

getDataTotalContacts() _v5

Gets total number of contacts status
PARAMETERS:
NONE
RETURN VALUE:
bool = True to allow showing total number of contacts | false otherwise

getDataTotalMembers() _v5

Gets total number of members status
PARAMETERS:
NONE
RETURN VALUE:
bool = True to allow showing total number of members | false otherwise

getDataTotalVisits() _v5

Gets total number of visits status
PARAMETERS:
NONE
RETURN VALUE:
bool = True to allow showing total number of visits | false otherwise

getDebugOn() _v5

Gets report debug mode settings
PARAMETERS:
NONE
RETURN VALUE:
bool = True if debug mode is on, false otherwise

getEndTime() _v5

Gets report end time as timestamp
PARAMETERS:
NONE
RETURN VALUE:
int = report end time as timestamp

getMemberID() _v5

Gets member ID
PARAMETERS:
NONE
RETURN VALUE:
int = Member ID

getReportList() _v5

Gets report list settings
PARAMETERS:
NONE
RETURN VALUE:
bool = True to allow getting report list, false otherwise

getShowAllMembers() _v5

Gets show all members settings status
PARAMETERS:
NONE
RETURN VALUE:
bool = True to show all members, false otherwise

getShowBotStats() _v5

Gets show bot stats status
PARAMETERS:
NONE
RETURN VALUE:
bool = True to show bot stats, false otherwise

getShowCountry() _v5

Gets report's country as 2 letters code
PARAMETERS:
NONE
RETURN VALUE:
string = report's country as 2 letters code

getShowMembersAreaStats() _v5

Gets show members area settings status
PARAMETERS:
NONE
RETURN VALUE:
bool = True to show members area stats, false otherwise

getShowMyStats() _v5

Gets report show stats status
PARAMETERS:
NONE
RETURN VALUE:
bool = True to show my stats, false to show everyone stats

getShowPagesStats() _v5

Gets show capture and landing pages stats status
PARAMETERS:
NONE
RETURN VALUE:
bool = True to show pages stats, false otherwise

getShowTotals() _v5

Gets report settings status for showing report totals
PARAMETERS:
NONE
RETURN VALUE:
bool = True to show report data totals, false otherwise

getTimeRange() _v5

Gets report time range number
PARAMETERS:
NONE
RETURN VALUE:
int = report time range number

getUsePanel() _v5

Gets report use panel value
PARAMETERS:
NONE
RETURN VALUE:
bool = True if use panel is allowed, false otherwise

hasDayTitle() _v5

Checks if the reports supports daily data
PARAMETERS:
NONE
RETURN VALUE:
bool = True if the report type supports daily data, false otherwise

hasDayTitleReport(string $reportTitle) _v5

Checks if the reports supports daily data
PARAMETERS:
$reportTitle = string, Report title
RETURN VALUE:
bool = True if the report type supports daily data, false otherwise

hasMultipleCols(string $reportName) _v5

Checks if the report has multiple columns
PARAMETERS:
$reportName = string, Report name
RETURN VALUE:
bool = True if the report has multiple columns, false otherwise

hasOldNew(string $reportName) _v5

Checks if the report has donut chart support
PARAMETERS:
$reportName = string, Report name
RETURN VALUE:
bool = True if the report has donut chart support, false otherwize

hasReport(string $reportTypeName, string $displayType, bool $hideUnavailableTime = false) _v5

Checks if a report name is valid
PARAMETERS:
$reportTypeName = string, Report type name
$displayType = string, Report display name
$hideUnavailableTime = bool, True to hide unavailable time (for calendar reports)
RETURN VALUE:
bool = True if the report name is valie, false otherwise

isAdded(string $displayType) _v5

Check if a report type is added
PARAMETERS:
$displayType = string, Report display type
RETURN VALUE:
bool = True if the report type has been added, false otherwise

isOnlyDisplayType(string $reportTypeName, string $displayType) _v5

Checks if a report name is a display name
PARAMETERS:
$reportTypeName = string, Report type name
$displayType = string, Report display name
RETURN VALUE:
bool = True if the report is only display name, false otherwise

removeReportType(string $reportTypeName) _v5

Remove a report type from report types array
PARAMETERS:
$reportTypeName = string, Report type name
RETURN VALUE:
void

setAddColumnArr(string $reportName, array $addColumnArr) _v5

Add a new column to a report
PARAMETERS:
$reportName = string, Report name
$addColumnArr = array, Report column array
RETURN VALUE:
void

setBeginTime(int $beginTime) _v5

Sets report start time
PARAMETERS:
$beginTime = int, Start time as timestamp
RETURN VALUE:
void

setDataTotal(bool $on = true) _v5

Toggle show data total details
PARAMETERS:
$on = bool, True to show data total details, false to hide it
RETURN VALUE:
void

setDataTotalContacts(bool $on = true) _v5

Toggle show data total contacts
PARAMETERS:
$on = bool, True to show total contacts, false to hide
RETURN VALUE:
void

setDataTotalMembers(bool $on = true) _v5

Toggle show data total members
PARAMETERS:
$on = bool, True to show total members, false to hide
RETURN VALUE:
void

setDataTotalVisits(bool $on = true) _v5

Toggle show data total visits
PARAMETERS:
$on = bool, True to show total visits, false to hide
RETURN VALUE:
void

setEndTime(int $endTime) _v5

Sets report end time
PARAMETERS:
$endTime = int, Report end time as timestamp
RETURN VALUE:
void

setMemberID(int $memberID) _v5

Sets report member ID
PARAMETERS:
$memberID = int, Member ID
RETURN VALUE:
void

setReportList(bool $on = true) _v5

Toggle report list setting
PARAMETERS:
$on = bool, True to turn on report list, false to turn off
RETURN VALUE:
void

setTimeRange(int $timeRange) _v5

Sets report time range
PARAMETERS:
$timeRange = int, Time range number
RETURN VALUE:
void

setUsePanel(bool $usePanel) _v5

toggle report use panel settings
PARAMETERS:
$usePanel = bool, True to allow use panel, false otherwise
RETURN VALUE:
void

showAllMembers(bool $showAll = true) _v5

Toggle show all members report
PARAMETERS:
$showAll = bool, True to show all members report, false to hide it
RETURN VALUE:
void

showBotStats(bool $status = true) _v5

Toggle bot stats report
PARAMETERS:
$status = bool, True to show bot stats , false otherwise
RETURN VALUE:
void

showCountry(string $country = "") _v5

Sets report country (2 letters code)
PARAMETERS:
$country = string, country 2 letters code
RETURN VALUE:
void

showMembersAreaStats(bool $status = true) _v5

Toggle show members area stats settings
PARAMETERS:
$status = bool, True to show members area stats, false otherwise
RETURN VALUE:
void

showMyStats(bool $stats = true) _v5

Toggle show my stats status
PARAMETERS:
$stats = bool, true to turn on show my stats, false to show all stats
RETURN VALUE:
void

showPagesStats(bool $status = true) _v5

Toggle page stats report
PARAMETERS:
$status = bool, True to show pages stats, false otherwise
RETURN VALUE:
void

showReport(string $reportTypeName, bool $hideUnavailableTime = false) _v5

Show report settings status
PARAMETERS:
$reportTypeName = string, Report type name
$hideUnavailableTime = bool, True to hide unavailable time, false otherwise. This only applied to calendar report types
RETURN VALUE:
bool = True to show report, false otherwise

showTotals(bool $totals = true) _v5

Toggle show report totals setting
PARAMETERS:
$totals = bool, True to turn on show total values
RETURN VALUE:
void