AnalyticsController
in package
Analytics Controller.
Handles analytics and learning API requests.
Table of Contents
Methods
- __construct() : mixed
- dismissAlert() : array<string|int, mixed>
- Dismiss alert.
- generateAlerts() : array<string|int, mixed>
- Generate system alerts.
- getAlertCounts() : array<string|int, mixed>
- Get alert counts.
- getAlerts() : array<string|int, mixed>
- Get active alerts.
- getConversionAnalysis() : array<string|int, mixed>
- Get conversion analysis.
- getDashboard() : array<string|int, mixed>
- Get analytics dashboard.
- getMetricHistory() : array<string|int, mixed>
- Get specific metric history.
- getPopularQueries() : array<string|int, mixed>
- Get popular queries.
- getSearchPatterns() : array<string|int, mixed>
- Get search patterns by time.
- getTrendingQueries() : array<string|int, mixed>
- Get trending queries.
- getZeroResultQueries() : array<string|int, mixed>
- Get zero-result queries.
- markAlertRead() : array<string|int, mixed>
- Mark alert as read.
Methods
__construct()
public
__construct() : mixed
dismissAlert()
Dismiss alert.
public
dismissAlert(int $id[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
- $id : int
- $userId : int|null = null
Return values
array<string|int, mixed>generateAlerts()
Generate system alerts.
public
generateAlerts([int|null $institutionId = null ]) : array<string|int, mixed>
Parameters
- $institutionId : int|null = null
Return values
array<string|int, mixed>getAlertCounts()
Get alert counts.
public
getAlertCounts([int|null $institutionId = null ]) : array<string|int, mixed>
Parameters
- $institutionId : int|null = null
Return values
array<string|int, mixed>getAlerts()
Get active alerts.
public
getAlerts([int|null $institutionId = null ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $institutionId : int|null = null
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>getConversionAnalysis()
Get conversion analysis.
public
getConversionAnalysis([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>getDashboard()
Get analytics dashboard.
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 specific metric history.
public
getMetricHistory(string $metricType[, int|null $institutionId = null ][, int $days = 30 ]) : array<string|int, mixed>
Parameters
- $metricType : string
- $institutionId : int|null = null
- $days : int = 30
Return values
array<string|int, mixed>getPopularQueries()
Get popular queries.
public
getPopularQueries([int|null $institutionId = null ][, int $days = 30 ][, int $limit = 20 ]) : array<string|int, mixed>
Parameters
- $institutionId : int|null = null
- $days : int = 30
- $limit : int = 20
Return values
array<string|int, mixed>getSearchPatterns()
Get search patterns by time.
public
getSearchPatterns([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>getTrendingQueries()
Get trending queries.
public
getTrendingQueries([int|null $institutionId = null ][, int $limit = 10 ]) : array<string|int, mixed>
Parameters
- $institutionId : int|null = null
- $limit : int = 10
Return values
array<string|int, mixed>getZeroResultQueries()
Get zero-result queries.
public
getZeroResultQueries([int|null $institutionId = null ][, int $days = 30 ][, int $limit = 20 ]) : array<string|int, mixed>
Parameters
- $institutionId : int|null = null
- $days : int = 30
- $limit : int = 20
Return values
array<string|int, mixed>markAlertRead()
Mark alert as read.
public
markAlertRead(int $id) : array<string|int, mixed>
Parameters
- $id : int