# Matomo Sites Manager API **Canonical:** https://apis.io/apis/matomo/matomo-sitesmanager-api/ **Provider:** Matomo — https://apis.io/providers/matomo/ **Base URL:** https://{matomo_host}/index.php **Documentation:** https://developer.matomo.org/api-reference/reporting-api Matomo Sites Manager API is one of 61 APIs that [Matomo](https://apis.io/providers/matomo/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include SitesManager. The published artifact set on APIs.io includes an OpenAPI specification and API documentation. The SitesManager API gives you full control on Websites in Matomo (create, update and delete), and many methods to retrieve websites based on various attributes. 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 Matomo 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 Matomo. ## Operations (53) | Method | Path | Summary | |---|---|---| | GET | `/index.php?module=API&method=SitesManager.getJavascriptTag` | — | | GET | `/index.php?module=API&method=SitesManager.getImageTrackingCode` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesFromGroup` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesGroups` | — | | GET | `/index.php?module=API&method=SitesManager.getSiteFromId` | — | | GET | `/index.php?module=API&method=SitesManager.getSiteUrlsFromId` | — | | GET | `/index.php?module=API&method=SitesManager.getAllSites` | — | | GET | `/index.php?module=API&method=SitesManager.getAllSitesId` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesWithAdminAccess` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesWithMinimumAccess` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesWithViewAccess` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesWithAtLeastViewAccess` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesIdWithAdminAccess` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesIdWithViewAccess` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesIdWithWriteAccess` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesIdWithAtLeastViewAccess` | — | | GET | `/index.php?module=API&method=SitesManager.getSitesIdFromSiteUrl` | — | | GET | `/index.php?module=API&method=SitesManager.addSite` | — | | GET | `/index.php?module=API&method=SitesManager.getSiteSettings` | — | | GET | `/index.php?module=API&method=SitesManager.deleteSite` | — | | GET | `/index.php?module=API&method=SitesManager.addSiteAliasUrls` | — | | GET | `/index.php?module=API&method=SitesManager.setSiteAliasUrls` | — | | GET | `/index.php?module=API&method=SitesManager.getIpsForRange` | — | | GET | `/index.php?module=API&method=SitesManager.setGlobalExcludedIps` | — | | GET | `/index.php?module=API&method=SitesManager.setGlobalSearchParameters` | — | | GET | `/index.php?module=API&method=SitesManager.getSearchKeywordParametersGlobal` | — | | GET | `/index.php?module=API&method=SitesManager.getSearchCategoryParametersGlobal` | — | | GET | `/index.php?module=API&method=SitesManager.getExcludedQueryParameters` | — | | GET | `/index.php?module=API&method=SitesManager.getExcludedQueryParametersGlobal` | — | | GET | `/index.php?module=API&method=SitesManager.getExcludedUserAgentsGlobal` | — | | GET | `/index.php?module=API&method=SitesManager.setGlobalExcludedUserAgents` | — | | GET | `/index.php?module=API&method=SitesManager.getExcludedReferrers` | — | | GET | `/index.php?module=API&method=SitesManager.getExcludedReferrersGlobal` | — | | GET | `/index.php?module=API&method=SitesManager.setGlobalExcludedReferrers` | — | | GET | `/index.php?module=API&method=SitesManager.getKeepURLFragmentsGlobal` | — | | GET | `/index.php?module=API&method=SitesManager.setKeepURLFragmentsGlobal` | — | | GET | `/index.php?module=API&method=SitesManager.getExcludedIpsGlobal` | — | | GET | `/index.php?module=API&method=SitesManager.getDefaultCurrency` | — | | GET | `/index.php?module=API&method=SitesManager.setDefaultCurrency` | — | | GET | `/index.php?module=API&method=SitesManager.getDefaultTimezone` | — | | GET | `/index.php?module=API&method=SitesManager.setDefaultTimezone` | — | | GET | `/index.php?module=API&method=SitesManager.setGlobalQueryParamExclusion` | — | | GET | `/index.php?module=API&method=SitesManager.getExclusionTypeForQueryParams` | — | | GET | `/index.php?module=API&method=SitesManager.updateSite` | — | | GET | `/index.php?module=API&method=SitesManager.getCurrencyList` | — | | GET | `/index.php?module=API&method=SitesManager.getCurrencySymbols` | — | | GET | `/index.php?module=API&method=SitesManager.isTimezoneSupportEnabled` | — | | GET | `/index.php?module=API&method=SitesManager.getTimezonesList` | — | | GET | `/index.php?module=API&method=SitesManager.getTimezoneName` | — | | GET | `/index.php?module=API&method=SitesManager.getUniqueSiteTimezones` | — | | GET | `/index.php?module=API&method=SitesManager.renameGroup` | — | | GET | `/index.php?module=API&method=SitesManager.getPatternMatchSites` | — | | GET | `/index.php?module=API&method=SitesManager.getNumWebsitesToDisplayPerPage` | — | ## Machine-readable artifacts (5) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-sitesmanager-api-openapi.yml - **Documentation** — https://developer.matomo.org/api-reference/reporting-api - **Documentation** — https://developer.matomo.org/api-reference/reporting-api#Live - **Documentation** — https://developer.matomo.org/api-reference/reporting-api#Goals - **Documentation** — https://developer.matomo.org/api-reference/reporting-api-segmentation ## Other Matomo APIs (12) - [Matomo Reporting API (index.php entrypoint)](https://apis.io/apis/matomo/matomo-index-php-api/) - [Matomo Tracking API (matomo.php entrypoint)](https://apis.io/apis/matomo/matomo-matomo-php-api/) - [Matomo Ab Testing API](https://apis.io/apis/matomo/matomo-abtesting-api/) - [Matomo Actions API](https://apis.io/apis/matomo/matomo-actions-api/) - [Matomo Activity Log API](https://apis.io/apis/matomo/matomo-activitylog-api/) - [Matomo Advertising Conversion Export API](https://apis.io/apis/matomo/matomo-advertisingconversionexport-api/) - [Matomo Annotations API](https://apis.io/apis/matomo/matomo-annotations-api/) - [Matomo API](https://apis.io/apis/matomo/matomo-api-api/) - [Matomo API Reference API](https://apis.io/apis/matomo/matomo-apireference-api/) - [Matomo Bandwidth API](https://apis.io/apis/matomo/matomo-bandwidth-api/) - [Matomo Cohorts API](https://apis.io/apis/matomo/matomo-cohorts-api/) - [Matomo Contents API](https://apis.io/apis/matomo/matomo-contents-api/) ## Tags SitesManager --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/matomo/matomo-sitesmanager-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/matomo/.