Get Timeseries
get_timeseriesRetrieve time-series traffic and conversion metrics for a site or page to identify trends and changes.
Instructions
Get traffic and conversion metrics over time for a site or specific page. Use to spot trends and changes around deploys.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| goal | No | Filter by goal name (e.g. Signup, Purchase) | |
| page | No | Filter by page path. Exact match by default, use * as trailing wildcard (e.g. /blog*) | |
| metrics | No | Metrics to return. Defaults vary by tool. | |
| site_id | Yes | Plausible site domain (e.g. example.com). Required. | |
| date_range | Yes | Date range: "7d", "30d", "12mo", "month", "year", "all", or "YYYY-MM-DD,YYYY-MM-DD" | |
| granularity | No | Time bucket size | day |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 |