class APIModule extends Module (View source)

Class APIModule.

Properties

protected RequestRepository $request from  Module

Methods

__construct(RequestRepository $request)

Module constructor.

from  Module
getOptions(string $format)

No description

from  Module
mixed
getPiwikVersion(string $format = null)

No description

mixed
getIpFromHeader(string $format = null)

No description

mixed
getSettings(string $format = null)

No description

mixed
getSegmentsMetadata(string[] $siteIds, string $format = null)

No description

mixed
getMetadata($arguments = [], string $format = null)

No description

mixed
getReportMetadata(string[] $siteIds, $arguments = [], string $format = null)

No description

mixed
getProcessedReport(string $apiModule, string $apiAction, $arguments = [], string $format = null)

No description

mixed
getReportPagesMetadata(string $format = null)

No description

mixed
getWidgetMetadata(string $format = null)

No description

mixed
get($arguments = [], string $format = null)

No description

mixed
getRowEvolution(string $apiModule, string $apiAction, $arguments = [], string $format = null)

No description

Details

__construct(RequestRepository $request)

Module constructor.

Parameters

RequestRepository $request

protected RequestOptions getOptions(string $format)

No description

Parameters

string $format

response format

Return Value

RequestOptions

mixed getPiwikVersion(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getIpFromHeader(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)* @param string $format

Return Value

mixed

mixed getSettings(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getSegmentsMetadata(string[] $siteIds, string $format = null)

No description

Parameters

string[] $siteIds

list of site ids to get segment metadata for

string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getMetadata($arguments = [], string $format = null)

No description

Parameters

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getReportMetadata(string[] $siteIds, $arguments = [], string $format = null)

No description

Parameters

string[] $siteIds

list of site ids to get report metadata for

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getProcessedReport(string $apiModule, string $apiAction, $arguments = [], string $format = null)

No description

Parameters

string $apiModule

api module to get report for

string $apiAction

api action/method to get report for

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getReportPagesMetadata(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getWidgetMetadata(string $format = null)

No description

Parameters

string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed get($arguments = [], string $format = null)

No description

Parameters

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getRowEvolution(string $apiModule, string $apiAction, $arguments = [], string $format = null)

No description

Parameters

string $apiModule

api module to get report for

string $apiAction

api action/method to get report for

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed