Skip to main content
Glama
plausible-mcp

plausible-mcp

by getsentry

Get Timeseries

get_timeseries
Read-onlyIdempotent

Retrieve traffic and conversion metrics over time for a site or page to spot trends and changes around deploys.

Instructions

Get traffic and conversion metrics over time for a site or specific page. Use to spot trends and changes around deploys.

Input Schema

NameRequiredDescriptionDefault
goalNoFilter by goal name (e.g. Signup, Purchase). Do not also target event:goal in property_filters; the call is rejected.
pageNoFilter 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.
metricsNoMetrics to return. Defaults vary by tool. Plausible rejects these combinations: bounce_rate or visit_duration with event:goal or event:props:<name> dimensions; pageviews, events, scroll_depth or time_on_page with visit:entry_page or visit:exit_page dimensions; views_per_visit with any non-time dimension or a page filter. For goal conversions use get_conversions.
site_idYesPlausible site domain (e.g. example.com). Required.
date_rangeYesDate 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.
granularityNoTime bucket size. Use "hour" with a sub-day or few-day date_range.day
property_filtersNoFilter 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

NameRequiredDescriptionDefault
metricsYesMetric keys, in the order they appear in each row's `metrics` array
resultsYesOne row per dimension-value combination returned by Plausible
dimensionsYesDimension keys, in the order they appear in each row's `dimensions` array
paginationNoPresent only on paged tools (get_breakdown)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv0.10.0
    • changedInput schema / properties / date_range / description
      Previous value: -"Date range: \"7d\", \"30d\", \"12mo\", \"month\", \"year\", \"all\", or \"YYYY-MM-DD,YYYY-MM-DD\""New value: +"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."
    • changedInput schema / properties / date_range / pattern
      Previous value: -"^(\\d+h|\\d+d|\\d+mo|day|month|year|all|\\d{4}-\\d{2}-\\d{2},\\d{4}-\\d{2}-\\d{2})$"New value: +"^(\\d+h|\\d+d|\\d+mo|day|month|year|all|\\d{4}-\\d{2}-\\d{2},\\d{4}-\\d{2}-\\d{2}|\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:Z|[+-]\\d{2}:\\d{2}),\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:Z|[+-]\\d{2}:\\d{2}))$"
    • changedInput schema / properties / goal / description
      Previous value: -"Filter by goal name (e.g. Signup, Purchase)"New value: +"Filter by goal name (e.g. Signup, Purchase). Do not also target event:goal in property_filters; the call is rejected."
    • changedInput schema / properties / granularity / description
      Previous value: -"Time bucket size"New value: +"Time bucket size. Use \"hour\" with a sub-day or few-day date_range."
    • changedInput schema / properties / granularity / enum
      Previous value: -[
      -  "day",
      -  "week",
      -  "month"
      -]New value: +[
      +  "hour",
      +  "day",
      +  "week",
      +  "month"
      +]
    • changedInput schema / properties / metrics / description
      Previous value: -"Metrics to return. Defaults vary by tool."New value: +"Metrics to return. Defaults vary by tool. Plausible rejects these combinations: bounce_rate or visit_duration with event:goal or event:props:<name> dimensions; pageviews, events, scroll_depth or time_on_page with visit:entry_page or visit:exit_page dimensions; views_per_visit with any non-time dimension or a page filter. For goal conversions use get_conversions."
    • changedInput schema / properties / page / description
      Previous value: -"Filter by page path. Exact match by default, use * as trailing wildcard (e.g. /blog*)"New value: +"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."
    • addedOutput schema / properties / pagination
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Present only on paged tools (get_breakdown)",
      +  "properties": {
      +    "has_more": {
      +      "description": "True when rows exist beyond this page",
      +      "type": "boolean"
      +    },
      +    "limit": {
      +      "description": "Max rows requested",
      +      "type": "number"
      +    },
      +    "offset": {
      +      "description": "Rows skipped before the first returned row",
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "limit",
      +    "offset",
      +    "has_more"
      +  ],
      +  "type": "object"
      +}
  2. Changed4 schema fields changedv0.9.0
    • removedOutput schema / properties / results / items / properties / dimensions / items / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "number"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / dimensions / items / type
      Added value: +[
      +  "string",
      +  "number"
      +]
    • removedOutput schema / properties / results / items / properties / metrics / items / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / metrics / items / type
      Added value: +[
      +  "number",
      +  "string",
      +  "null"
      +]
  3. Changed1 schema field changedv0.7.2
    • addedInput schema / properties / property_filters / items / properties / values / items / maxLength
      Added value: +1024
  4. Changed5 schema fields changedv0.7.1
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / properties / property_filters
      Added value: +{
      +  "description": "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.",
      +  "items": {
      +    "properties": {
      +      "operator": {
      +        "default": "is",
      +        "description": "Match operator: is, is_not, contains, contains_not (default: is)",
      +        "enum": [
      +          "is",
      +          "is_not",
      +          "contains",
      +          "contains_not"
      +        ],
      +        "type": "string"
      +      },
      +      "property": {
      +        "description": "What to filter on: a built-in dimension (e.g. \"visit:channel\", \"visit:source\", \"event:page\") or a custom event property as its bare name (e.g. \"plan\" targets event:props:plan)",
      +        "maxLength": 312,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "values": {
      +        "description": "One or more values to match the property against",
      +        "items": {
      +          "type": "string"
      +        },
      +        "minItems": 1,
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "property",
      +      "values"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedInput schema / properties / site_id / description
      Previous value: -"Plausible site domain (e.g. example.com). Uses PLAUSIBLE_DEFAULT_SITE_ID if omitted."New value: +"Plausible site domain (e.g. example.com). Required."
    • changedInput schema / required
      Previous value: -[
      -  "date_range"
      -]New value: +[
      +  "site_id",
      +  "date_range"
      +]
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  5. First observedv0.5.1

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly, idempotent and openWorld, so the safety profile is covered. The description adds only the scope ('a site or specific page') and gives no behavioral detail such as rate limits, data freshness, or handling of empty buckets. With annotations and an output schema carrying most of the burden, a 3 is appropriate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with what is returned and followed by when to reach for it. No filler, no repetition of schema content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema, a fully documented input schema, and annotations, the description needs to supply only purpose and routing, and it does so. The one real gap is lack of explicit sibling differentiation against get_breakdown and compare_periods, which an agent would need in order to pick this tool confidently.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so every parameter including date_range syntax, granularity, metrics conflicts, and property_filters is fully documented in the schema. The description only hints at page-level scoping ('or specific page'), which adds marginal value and earns the baseline 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: retrieve traffic and conversion metrics over time, scoped to a site or a specific page. That is clear enough to distinguish it from get_breakdown or compare_periods, but the description never names those siblings, so differentiation depends on inference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'Use to spot trends and changes around deploys' gives an implied usage context, which is better than nothing. However, it names no alternatives and sets no exclusions, so an agent must read the sibling schemas or the get_conversions reference buried in the metrics parameter to choose correctly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.