Get Site

Retrieve details about a specific site

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.

Show Configuration Fields

tracker_script_configuration.id · string

The unique identifier for this configuration.

tracker_script_configuration.installation_type · string

The installation method (e.g., manual, wordpress, or null).

tracker_script_configuration.track_404_pages · boolean

Whether 404 tracking is enabled.

tracker_script_configuration.hash_based_routing · boolean

Whether hash-based routing is enabled.

tracker_script_configuration.outbound_links · boolean

Whether outbound link tracking is enabled.

tracker_script_configuration.file_downloads · boolean

Whether file download tracking is enabled.

tracker_script_configuration.revenue_tracking · boolean

Whether revenue tracking is enabled.

tracker_script_configuration.tagged_events · boolean

Whether CSS class-based event tracking is enabled.

tracker_script_configuration.form_submissions · boolean

Whether form submission tracking is enabled.

tracker_script_configuration.pageview_props · boolean

Whether pageview properties are enabled.

cURL

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