Create Site

Create a new site in your Plausible Analytics account

POST /api/v1/sites

Creates a new site with the specified domain and configuration. Requires the sites:provision:* API scope.

This endpoint is only available with a subscription that includes the Sites API feature.

Authentication

Requires a valid API key with the sites:provision:* scope passed in the Authorization header.

Request Body

domain · string · required

The domain of the site to create. The domain will be automatically normalized (lowercased, stripped of protocol/www prefix).

Examples: example.com, blog.example.com, 音乐.cn

International domain names (IDNs) are supported. URI reserved characters (:, ?, #, [, ], @, !, $, &, ', (, ), *, +, ,, ;, =) are not allowed.

timezone · string · default: "Etc/UTC"

The timezone for the site. Must be a valid IANA timezone identifier.

Examples: America/New_York, Europe/London, Asia/Tokyo

team_id · string

The identifier of the team to create the site under. If not provided, the site will be created under the user’s default team.

Note: If using a team-scoped API key, this parameter is ignored and the site is created under the API key’s team.

tracker_script_configuration · object

Optional configuration for the tracker script. If not provided, default values will be used.

Show Tracker Script Configuration Fields

tracker_script_configuration.installation_type · string

The installation method used. Valid values: manual, wordpress, or null.

tracker_script_configuration.track_404_pages · boolean · default: false

Enable tracking of 404 error pages.

tracker_script_configuration.hash_based_routing · boolean · default: false

Enable hash-based routing for single-page applications.

tracker_script_configuration.outbound_links · boolean · default: false

Enable automatic tracking of outbound link clicks.

tracker_script_configuration.file_downloads · boolean · default: false

Enable automatic tracking of file downloads.

tracker_script_configuration.revenue_tracking · boolean · default: false

Enable revenue tracking for goals.

tracker_script_configuration.tagged_events · boolean · default: false

Enable CSS class-based event tracking.

tracker_script_configuration.form_submissions · boolean · default: false

Enable automatic tracking of form submissions.

tracker_script_configuration.pageview_props · boolean · default: false

Enable custom properties on pageviews.

Response

domain · string

The domain of the created site.

timezone · string

The timezone of the created site.

custom_properties · array

List of allowed custom event properties for the site. Empty array by default.

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 -X POST https://plausible.io/api/v1/sites \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example.com",
    "timezone": "America/New_York"
  }'