Heratio Framework API Reference

AnalyticsService
in package

Analytics Service.

Main analytics dashboard and metrics.

Table of Contents

Methods

getDashboard()  : array<string|int, mixed>
Get dashboard summary.
getMetricHistory()  : Collection
Get metric history.
recordDailyMetric()  : void
Record daily metric.

Methods

getDashboard()

Get dashboard summary.

public getDashboard([int|null $institutionId = null ][, int $days = 30 ]) : array<string|int, mixed>
Parameters
$institutionId : int|null = null
$days : int = 30
Return values
array<string|int, mixed>

getMetricHistory()

Get metric history.

public getMetricHistory(string $metricType[, int|null $institutionId = null ][, int $days = 30 ]) : Collection
Parameters
$metricType : string
$institutionId : int|null = null
$days : int = 30
Return values
Collection

recordDailyMetric()

Record daily metric.

public recordDailyMetric(string $metricType, float $value[, int|null $institutionId = null ][, string|null $date = null ]) : void
Parameters
$metricType : string
$value : float
$institutionId : int|null = null
$date : string|null = null

        
On this page

Search results