Stats
extends ManagementEndpoint
in package
implements
StatsInterface
Class Stats.
Handles requests to the Stats endpoint of the v2 Management API.
Tags
Interfaces, Classes, Traits and Enums
- StatsInterface
- Interface StatsInterface.
Table of Contents
- $httpClient : HttpClient
- __construct() : mixed
- ManagementEndpoint constructor.
- getActiveUsers() : ResponseInterface
- Get active user count statistics.
- getDaily() : ResponseInterface
- Get daily statistics from a period of time.
- getHttpClient() : HttpClient
- Get the injected HttpClient instance.
- getLastRequest() : HttpRequest|null
- Return an instance of HttpRequest representing the last issued request.
- getResponsePaginator() : HttpResponsePaginator
- Return a ResponsePaginator instance configured for the last HttpRequest.
- instance() : static
Properties
$httpClient
private
HttpClient
$httpClient
Methods
__construct()
ManagementEndpoint constructor.
public
final __construct(HttpClient $httpClient) : mixed
Parameters
- $httpClient : HttpClient
-
httpClient instance to use
Return values
mixed —getActiveUsers()
Get active user count statistics.
public
getActiveUsers([RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:stats.
Parameters
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —getDaily()
Get daily statistics from a period of time.
public
getDaily([string|null $from = null ][, string|null $to = null ][, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:stats.
Parameters
- $from : string|null = null
-
Optional. Beginning from this date; YYYYMMDD format.
- $to : string|null = null
-
Optional. Ending from this date; YYYYMMDD format.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —getHttpClient()
Get the injected HttpClient instance.
public
final getHttpClient() : HttpClient
Return values
HttpClient —getLastRequest()
Return an instance of HttpRequest representing the last issued request.
public
final getLastRequest() : HttpRequest|null
Return values
HttpRequest|null —getResponsePaginator()
Return a ResponsePaginator instance configured for the last HttpRequest.
public
final getResponsePaginator() : HttpResponsePaginator
Return values
HttpResponsePaginator —instance()
public
static instance(HttpClient $httpClient) : static
Parameters
- $httpClient : HttpClient