Skip to content

Update docs on goals w/ custom props support #658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
metmarkosaric merged 2 commits into from
Feb 3, 2026
Merged

Update docs on goals w/ custom props support #658

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
481510c
Update docs on goals w/ custom props support
aerosol Feb 2, 2026
7eaee6e
comma
aerosol Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/sites-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,14 +363,18 @@ 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"
}
},
{
"id": "2",
"goal_type": "page",
"display_name": "Visit /register",
"event_name": null,
"page_path": "/register"
"page_path": "/register",
"custom_props": {}
}
],
"meta": {
Expand Down Expand Up @@ -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).

<hr / >

### DELETE /api/v1/sites/goals/:goal_id
Expand Down