Get Conversions
get_conversionsRetrieve goal conversion rates and counts for a Plausible site, optionally breaking results down by page to identify which pages drive conversions.
Instructions
Get goal conversion rates and counts. Can break down by page to see which pages drive conversions.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"site_id": "<site_id>",
"date_range": "<date_range>"
},
"name": "get_conversions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| goal | No | Filter by goal name (e.g. Signup, Purchase). Do not also target event:goal in property_filters; the call is rejected. | |
| page | No | Filter by page path. Exact match by default, use * as trailing wildcard (e.g. /blog*). Do not also target event:page in property_filters; the call is rejected. | |
| site_id | Yes | Plausible site domain (e.g. example.com). Required. | |
| date_range | Yes | Date range: "1h", "24h" (last N hours, ending now), "7d", "30d", "12mo", "month", "year", "all", "YYYY-MM-DD,YYYY-MM-DD" (start,end, both inclusive), or "YYYY-MM-DDTHH:MM:SSZ,YYYY-MM-DDTHH:MM:SSZ" for a sub-day window (any offset, e.g. +02:00). Days after today count as zero. | |
| property_filters | No | Filter results by built-in dimensions or custom event properties, e.g. [{ "property": "visit:channel", "operator": "is", "values": ["Organic Search"] }] or [{ "property": "plan", "values": ["pro"] }]. Entries are combined with AND. | |
| breakdown_by_page | No | If true, adds event:page and each page's group_conversion_rate: the percent of that page's visitors who converted |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Facts about this result that change how to read its numbers | |
| metrics | Yes | Metric keys, in the order they appear in each row's `metrics` array | |
| results | Yes | One row per dimension-value combination returned by Plausible | |
| dimensions | Yes | Dimension keys, in the order they appear in each row's `dimensions` array | |
| pagination | No | Present only on paged tools (get_breakdown) |