From 481510c5aad0d58a2bd90e0fc9688a465b16e538 Mon Sep 17 00:00:00 2001 From: Adam Rutkowski Date: Mon, 2 Feb 2026 14:26:29 +0100 Subject: [PATCH 1/2] Update docs on goals w/ custom props support --- docs/sites-api.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/sites-api.md b/docs/sites-api.md index 93e4bfba..e56d3e81 100644 --- a/docs/sites-api.md +++ b/docs/sites-api.md @@ -364,13 +364,17 @@ curl -X GET https://plausible.io/api/v1/sites/goals?site_id=test-domain.com \ "display_name": "Signup", "event_name": "Signup", "page_path": null + "custom_props": { + "country": "Estonia" + } }, { "id": "2", "goal_type": "page", "display_name": "Visit /register", "event_name": null, - "page_path": "/register" + "page_path": "/register", + "custom_props": {} } ], "meta": { @@ -463,6 +467,10 @@ Actual value of the page path of your goal, also accepts wildcards for type `pag The value under which the goal is available in the dashboard, as well as in the [Stats API](/stats-api). If not provided, for custom events the `display_name` becomes `event_name` and `Visit {page_path}` in case of pageview goals. +**custom_props** + +A map of custom properties to be part of the goal (keys designate custom property names, and values custom property values). +
### DELETE /api/v1/sites/goals/:goal_id From 7eaee6e8f3ac9b0e5cd99bd05bd1f6e4b648e459 Mon Sep 17 00:00:00 2001 From: Adam Rutkowski Date: Mon, 2 Feb 2026 14:34:56 +0100 Subject: [PATCH 2/2] comma --- docs/sites-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sites-api.md b/docs/sites-api.md index e56d3e81..618509e9 100644 --- a/docs/sites-api.md +++ b/docs/sites-api.md @@ -363,7 +363,7 @@ curl -X GET https://plausible.io/api/v1/sites/goals?site_id=test-domain.com \ "goal_type": "event", "display_name": "Signup", "event_name": "Signup", - "page_path": null + "page_path": null, "custom_props": { "country": "Estonia" }