• Home
• Piwik
• Plugins
• SitesManager
• API

PHP Class Piwik\Plugins\SitesManager\API

This API lets you create websites via "addSite", update existing websites via "updateSite" and delete websites via "deleteSite". When creating websites, it can be useful to access internal codes used by Piwik for currencies via "getCurrencyList", or timezones via "getTimezonesList". There are also many ways to request a list of websites: from the website ID via "getSiteFromId" or the site URL via "getSitesIdFromSiteUrl". Often, the most useful technique is to list all websites that are known to a current user, based on the token_auth, via "getSitesWithAdminAccess", "getSitesWithViewAccess" or "getSitesWithAtLeastViewAccess" (which returns both). Some methods will affect all websites globally: "setGlobalExcludedIps" will set the list of IPs to be excluded on all websites, "setGlobalExcludedQueryParameters" will set the list of URL parameters to remove from URLs for all websites. The existing values can be fetched via "getExcludedIpsGlobal" and "getExcludedQueryParametersGlobal". See also the documentation about Managing Websites in Piwik. Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
__construct ( SettingsProvider $provider, SettingsMetadata $settingsMetadata )
addSite ( string $siteName, array | string $urls = null, integer $ecommerce = null, null $siteSearch = null, string $searchKeywordParameters = null, string $searchCategoryParameters = null, string $excludedIps = null, null $excludedQueryParameters = null, string $timezone = null, string $currency = null, string $group = null, string $startDate = null, null | string $excludedUserAgents = null, integer $keepURLFragments = null, string $type = null, array | null $settingValues = null, boolean | null $excludeUnknownUrls = null ) : integer	Add a website.
addSiteAliasUrls ( integer $idSite, array | string $urls ) : integer	Add a list of alias Urls to the given idSite
deleteSite ( integer $idSite )	Delete a website from the database, given its Id. The method deletes the actual site as well as some associated data. However, it does not delete any logs or archives that belong to this website. You can delete logs and archives for a site manually as described in this FAQ: http://piwik.org/faq/how-to/faq_73/ .
getAllSites ( ) : array	Returns all websites, requires Super User access
getAllSitesId ( ) : array	Returns the list of all the website IDs registered.
getCurrencyList ( ) : array	Returns the list of supported currencies
getCurrencySymbols ( ) : array(	Returns the list of currency symbols
getDefaultCurrency ( ) : string	Returns the default currency that will be set when creating a website through the API.
getDefaultTimezone ( ) : string	Returns the default timezone that will be set when creating a website through the API.
getExcludedIpsGlobal ( ) : string	Returns the list of IPs that are excluded from all websites
getExcludedQueryParametersGlobal ( ) : string	Returns the list of URL query parameters that are excluded from all websites
getExcludedUserAgentsGlobal ( ) : string	Returns the list of user agent substrings to look for when excluding visits for all websites. If a visitor's user agent string contains one of these substrings, their visits will not be included.
getImageTrackingCode ( integer $idSite, string $piwikUrl = '', $actionName = false, integer $idGoal = false, integer $revenue = false ) : string	Returns image link tracking code for a given site with specified options.
getIpsForRange ( string $ipRange ) : array | false	Get the start and end IP addresses for an IP address range
getJavascriptTag ( integer $idSite, string $piwikUrl = '', boolean $mergeSubdomains = false, boolean $groupPageTitlesByDomain = false, boolean $mergeAliasUrls = false, boolean $visitorCustomVariables = false, boolean $pageCustomVariables = false, boolean $customCampaignNameQueryParam = false, boolean $customCampaignKeywordParam = false, boolean $doNotTrack = false, boolean $disableCookies = false, boolean $trackNoScript = false ) : string	Returns the javascript tag for the given idSite.
getKeepURLFragmentsGlobal ( ) : boolean	Returns true if the default behavior is to keep URL fragments when tracking, false if otherwise.
getNumWebsitesToDisplayPerPage ( ) : integer	Returns the number of websites to display per page.
getPatternMatchSites ( string $pattern, integer | false $limit = false ) : array	Find websites matching the given pattern.
getSearchCategoryParametersGlobal ( ) : string
getSearchKeywordParametersGlobal ( ) : string
getSiteFromId ( integer $idSite ) : array	Returns the website information : name, main_url
getSiteSettings ( $idSite )
getSiteUrlsFromId ( integer $idSite ) : array	Returns the list of all URLs registered for the given idSite (main_url + alias URLs).
getSitesFromGroup ( string $group = '' ) : array	Returns all websites belonging to the specified group
getSitesGroups ( ) : array	Returns the list of website groups, including the empty group if no group were specified for some websites
getSitesIdFromSiteUrl ( string $url ) : array	Returns the list of websites ID associated with a URL.
getSitesIdFromTimezones ( array $timezones ) : array	Returns all websites with a timezone matching one the specified timezones
getSitesIdWithAdminAccess ( ) : array	Returns the list of websites ID with the 'admin' access for the current user.
getSitesIdWithAtLeastViewAccess ( boolean $_restrictSitesToLogin = false ) : array	Returns the list of websites ID with the 'view' or 'admin' access for the current user.
getSitesIdWithViewAccess ( ) : array	Returns the list of websites ID with the 'view' access for the current user.
getSitesIdWithVisits ( boolean | integer $timestamp = false ) : array	Returns the list of the website IDs that received some visits since the specified timestamp.
getSitesWithAdminAccess ( boolean $fetchAliasUrls = false, false | string $pattern = false, false | integer $limit = false ) : array	Returns the list of websites with the 'admin' access for the current user.
getSitesWithAtLeastViewAccess ( boolean | integer $limit = false, boolean $_restrictSitesToLogin = false ) : array	Returns the list of websites with the 'view' or 'admin' access for the current user.
getSitesWithViewAccess ( ) : array	Returns the list of websites with the 'view' access for the current user.
getTimezonesList ( ) : array	Returns the list of timezones supported.
getUniqueSiteTimezones ( ) : array	Returns the list of unique timezones from all configured sites.
isSiteSpecificUserAgentExcludeEnabled ( ) : boolean	Returns true if site-specific user agent exclusion has been enabled. If it hasn't, only the global user agent substrings (see @setGlobalExcludedUserAgents) will be used.
isTimezoneSupportEnabled ( ) : boolean	Return true if Timezone support is enabled on server
renameGroup ( $oldGroupName, $newGroupName )
setDefaultCurrency ( string $defaultCurrency ) : boolean	Sets the default currency that will be used when creating websites
setDefaultTimezone ( string $defaultTimezone ) : boolean	Sets the default timezone that will be used when creating websites
setGlobalExcludedIps ( string $excludedIps ) : boolean	Sets IPs to be excluded from all websites. IPs can contain wildcards.
setGlobalExcludedQueryParameters ( string $excludedQueryParameters ) : boolean	Sets list of URL query parameters to be excluded on all websites.
setGlobalExcludedUserAgents ( string $excludedUserAgents )	Sets list of user agent substrings to look for when excluding visits. For more info,
setGlobalSearchParameters ( $searchKeywordParameters, $searchCategoryParameters ) : boolean	Sets Site Search keyword/category parameter names, to be used on websites which have not specified these values Expects Comma separated list of query params names
setKeepURLFragmentsGlobal ( $enabled )	Sets whether the default behavior should be to keep URL fragments when tracking or not.
setSiteAliasUrls ( $idSite, $urls = [] ) : integer	Set the list of alias Urls for the given idSite
setSiteSpecificUserAgentExcludeEnabled ( boolean $enabled )	Sets whether it should be allowed to exclude different user agents for different websites.
updateSite ( integer $idSite, string $siteName = null, string | array $urls = null, integer $ecommerce = null, null | integer $siteSearch = null, string $searchKeywordParameters = null, string $searchCategoryParameters = null, string $excludedIps = null, null | string $excludedQueryParameters = null, string $timezone = null, string $currency = null, string $group = null, string $startDate = null, null | string $excludedUserAgents = null, integer | null $keepURLFragments = null, string $type = null, array | null $settingValues = null, boolean | null $excludeUnknownUrls = null ) : boolean	Update an existing website.
updateSiteCreatedTime ( $idSites, Date $minDate )	Updates the field ts_created for the specified websites.

Protected Methods

Method	Description
getNormalizedUrls ( $url )

Private Methods

Method	Description
checkAndReturnCommaSeparatedStringList ( $parameters )
checkAndReturnExcludedIps ( string $excludedIps ) : array	Checks that the submitted IPs (comma separated list) are valid Returns the cleaned up IPs
checkAndReturnType ( $type )
checkName ( $siteName )	Check that the website name has a correct format.
checkValidCurrency ( $currency )
checkValidTimezone ( $timezone )
getModel ( )
getSitesFromIds ( array $idSites, boolean $limit = false ) : array	Returns the list of websites from the ID array in parameters.
getSitesId ( )
getTimezonesListUTCOffsets ( )
isValidIp ( string $ip ) : boolean	Tests if the IP is a valid IP, allowing wildcards, except in the first octet.
isValidUrl ( string $url ) : boolean	Tests if the URL is a valid URL
postUpdateWebsite ( $idSite )
removeTrailingSlash ( string $url ) : string	Remove the final slash in the URLs if found
saveMeasurableSettings ( $idSite, $idType, $settingValues )
setAndValidateMeasurableSettings ( $idSite, $idType, $settingValues )
setSettingValue ( $fieldName, $value, $settingValues )

Method Details