Skip to main content
Glama

Export project rank history

export_rank_history
Read-only

Retrieve historical keyword rank data as cursor-paginated JSON, with filters for dates, keywords, and granularity. Export raw observations or legacy rows for analysis.

Instructions

Export project rank history as cursor-paginated JSON. Version 1 preserves legacy rows; version 2 retains raw observations/attempts, frozen scope/time and quality metadata. For full streamed CSV dumps, use the REST endpoint directly.

Input Schema

NameRequiredDescriptionDefault
toNoInclusive version 2 window end, supplied together with from.
fromNoInclusive version 2 window start, supplied together with to.
basisNoTimestamp selecting version 2 records. Attempts require recorded_at.
limitNo
rangeNo
cursorNoOpaque continuation from this export; preserve all selected options.
streamNoVersion 2 normalized observations or logical checks plus retained run/item outcomes; this never launches a check.
versionNo1 retains legacy rows; 2 returns frozen report records and quality metadata.
project_idYesIdentifier of the bisibility project to operate on; list_projects returns valid project ids.
aggregationNoVersion 2 exports raw records without aggregation.
granularityNo
keyword_idsNoTracked keyword public IDs to include in the export.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv0.17.1
    • addedInput schema / properties / aggregation
      Added value: +{
      +  "const": "none",
      +  "description": "Version 2 exports raw records without aggregation.",
      +  "type": "string"
      +}
    • addedInput schema / properties / basis
      Added value: +{
      +  "description": "Timestamp selecting version 2 records. Attempts require recorded_at.",
      +  "enum": [
      +    "observed_at",
      +    "recorded_at"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / cursor / description
      Added value: +"Opaque continuation from this export; preserve all selected options."
    • changedInput schema / properties / cursor / maxLength
      Previous value: -512New value: +8192
    • addedInput schema / properties / from
      Added value: +{
      +  "description": "Inclusive version 2 window start, supplied together with to.",
      +  "format": "date-time",
      +  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      +  "type": "string"
      +}
    • changedInput schema / properties / keyword_ids / description
      Previous value: -"Tracked keyword ids to include in the export."New value: +"Tracked keyword public IDs to include in the export."
    • addedInput schema / properties / stream
      Added value: +{
      +  "description": "Version 2 normalized observations or logical checks plus retained run/item outcomes; this never launches a check.",
      +  "enum": [
      +    "observations",
      +    "attempts"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / to
      Added value: +{
      +  "description": "Inclusive version 2 window end, supplied together with from.",
      +  "format": "date-time",
      +  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      +  "type": "string"
      +}
    • addedInput schema / properties / version
      Added value: +{
      +  "description": "1 retains legacy rows; 2 returns frozen report records and quality metadata.",
      +  "enum": [
      +    "1",
      +    "2"
      +  ],
      +  "type": "string"
      +}
  2. First observedv0.6.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already establish readOnlyHint=true, destructiveHint=false, openWorldHint=false, so safety is covered. The description adds genuinely useful behavior: cursor-paginated output, version 1 legacy rows vs version 2 raw observations/attempts with frozen scope/time and quality metadata, and that streamed CSV requires a different mechanism.

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?

Three sentences, no filler, and the core function (cursor-paginated JSON export) is front-loaded before version nuance and the alternative endpoint. Every sentence carries information.

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?

For a read-only export tool whose annotations cover safety and whose schema documents most parameters, the description is nearly complete: it conveys format, pagination, versions and the CSV alternative. The only real gap is the lack of differentiation from get_rank_history.

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 75%, so most parameters are self-documenting. The description adds meaning on top of the schema by explaining version 1 vs 2 semantics and framing the export as cursor-paginated, complementing the cursor and version parameter descriptions.

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+resource (export project rank history) and format (cursor-paginated JSON), and the version semantics further sharpen the scope. However, it never names the obvious sibling get_rank_history, so an agent must infer the distinction from naming alone.

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 closing sentence routes agents to the REST endpoint for CSV dumps, which is useful when-not guidance. But it offers no guidance on choosing this tool over the sibling get_rank_history, leaving the primary alternative unaddressed.

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

Deploy Server

Other Tools