twelvebit Analytics

Scroll depth for one page

get_page_scroll

Read-onlyIdempotent

Scroll depth for one exact page path, independent of top-page ranking. Returns median maximum depth (0–100 percent), measured and tracked page-view counts, measurement coverage (0–1 fraction), and 25/50/75/100% milestone counts and shares of measured views (0–1 fractions). Missing median and shares are null, not zero. Imported history is excluded. Uses the same date range, visit filters and bot/hidden-country exclusions as the Page panel. A page filter narrows visits; path selects the exact page within those visits. Measures content exposure, not reading; short pages can reach 100% without scrolling.

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": {
      "path": "<path>"
    },
    "name": "get_page_scroll"
  }
}

Input Schema

Name	Required	Description
`to`	No	Last day, inclusive (YYYY-MM-DD).
`from`	No	First day (YYYY-MM-DD, site time zone). Use with to instead of period.
`path`	Yes	Exact page path from get_breakdown with dim=page, e.g. /pricing. Do not pass the full URL.
`site`	No	Site domain (example.com), id or public id (tb_…). Optional with a site key, or when the account has one site.
`period`	No	Time range. Default 30d. today, yesterday, 24h, 7d, 30d, 90d, 12m, wtd, mtd, ytd, all.
`filters`	No	Only visits that match every filter. A value is "is": {"country": "US"}; a list is "is any of": {"country": ["PT", "ES"]}; an object picks the operator: {"page": {"contains": "/blog"}}, {"channel": {"is_not": ["Direct", "Email"]}}, {"page": {"not_contains": "/admin"}}. Operators: is, is_not, contains, not_contains (case-insensitive). "visitor" is "new" or "returning". "ad" is an ad campaign as "google:<campaign id>" or "meta:<campaign id>" (the visits that the Ads page counts for it). Use "(none)" for empty values; countries take ISO codes or English names.

Schema Changelog

Changes observed during successful MCP inspections.

AddedOct 30, 2026

TDQS

A4.6/5.0

Behavior5/5

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

Annotations already cover the read-only/idempotent safety profile, and the description layers on non-obvious behavior: imported history is excluded, bot and hidden-country exclusions apply, missing values are null rather than zero, and short pages can reach 100% without scrolling. These caveats materially change how an agent should interpret results.

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

Conciseness4/5

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

Return values are front-loaded and every sentence carries information, but the block is dense — the metric list, the null/zero rule, the exclusion rules and the interpretation caveat could be tightened into fewer clauses without losing meaning.

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

Completeness5/5

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

No output schema exists, so the description must carry the return contract, and it does: median depth, view counts, coverage fraction, milestone counts and shares, plus null semantics. Combined with the filter/exclusion notes, an agent has everything needed to call and interpret it.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds genuine meaning by contrasting `path` (exact page) against a `page` filter (narrows visits) and by attaching the tool's result caveats to the shared date-range/filter semantics.

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

Purpose5/5

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

Names a specific metric and resource ('scroll depth for one exact page path') and explicitly differentiates it from the aggregate page view ('independent of top-page ranking'). The agent can tell it apart from get_breakdown without inspecting either schema.

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

Usage Guidelines4/5

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

Clarifies that the path parameter targets the exact page while a page filter only narrows the visit set, and that it reuses the Page panel's date range, filters and exclusions. It does not explicitly say when to prefer this over get_breakdown with dim=page, so the alternative routing is implied rather than stated.

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

All twelvebit Analytics tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?