Skip to main content

GET /api/v1/sites/:site_id

Retrieves information about a specific site. The site_id parameter can be either the current domain or the previous domain (if the domain was changed).

Authentication

Requires a valid API key with either:
  • sites:read:* scope (read-only access)
  • sites:provision:* scope (full access)

Path Parameters

site_id
string
required
The domain of the site to retrieve. Can be the current domain or the previous domain if it was changed.Examples: example.com, blog.example.com

Response

domain
string
The current domain of the site.
timezone
string
The timezone configured for the site.
custom_properties
array
List of allowed custom event properties for this site. These are the properties that can be attached to custom events.
tracker_script_configuration
object
The tracker script configuration for the site.
curl https://plausible.io/api/v1/sites/example.com \
  -H "Authorization: Bearer YOUR_API_KEY"

Notes

  • You must have at least viewer-level access to the site to retrieve its information
  • If the site’s domain was changed, you can use either the old or new domain to access it
  • Team-scoped API keys will only return sites belonging to the specified team

Build docs developers (and LLMs) love