src/RobBrazier/Piwik/Module/ReferrersModule.php
<?php
namespace RobBrazier\Piwik\Module;
/**
* Class ReferrersModule.
*
* @see https://developer.matomo.org/api-reference/reporting-api#Referrers for arguments
*/
class ReferrersModule extends Module
{
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getReferrerType($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getAll($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getKeywords($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param string $pageUrl page url to get keywords for
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getKeywordsForPageUrl($pageUrl, $arguments = [], $format = null)
{
$arguments += ['url' => $pageUrl];
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param string $pageTitle page title to get keywords for
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getKeywordsForPageTitle($pageTitle, $arguments = [], $format = null)
{
$arguments += ['title' => $pageTitle];
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getSearchEnginesFromKeywordId($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getSearchEngines($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getKeywordsFromSearchEngineId($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getCampaigns($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getKeywordsFromCampaignId($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getWebsites($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getUrlsFromWebsiteId($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getSocials($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getUrlsForSocial($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getNumberOfDistinctSearchEngines($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getNumberOfDistinctKeywords($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getNumberOfDistinctCampaigns($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getNumberOfDistinctWebsites($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
/**
* @param array[string]mixed $arguments extra arguments to be passed to the api call
* @param string $format override format (defaults to one specified in config file)
*
* @return mixed
*/
public function getNumberOfDistinctWebsitesUrls($arguments = [], $format = null)
{
$options = $this->getOptions($format)->setArguments($arguments);
return $this->request->send($options);
}
}