Docs menu

TOOLS

record_change

How do I note that we shipped a change on a page, so its effect can be checked later?

  • Changes data · needs Read and make changes
  • No external calls

When to use it

Records a change marker: on this deploy date, this kind of change shipped on this exact page, with an optional note and ticket reference. Use it right after a fix goes live. QueryHippo only stores the marker; it does not change your site.

Ask your AI

  • Record that we rewrote the title on /compare/svelte-virtuallists today, ticket HUM-52.
  • Note that we added internal links to the pricing page on 2026-10-20.
  • Mark the technical fix we deployed to the docs home page yesterday.

Parameters

NameTypeDetailsWhat it means
propertyId(required)string1–200 characterspattern ^[a-zA-Z0-9._:-]+$The ID of the site, as returned by list_sites. You must own the site.
page(required)string1–4096 charactersThe exact page URL as Search Console reports it: an absolute http or https URL of up to 4,096 characters.
change_kind(required)"title_meta" | "content" | "internal_links" | "technical" | "other"—What changed: "title_meta" (title or meta description), "content", "internal_links", "technical" or "other".
deployed_on(required)stringpattern ^\d{4}-\d{2}-\d{2}$The day the change went live (YYYY-MM-DD), from 2000-01-01 to tomorrow in UTC.
notestring1–500 charactersOptional short description of the change, up to 500 characters, on one line.
external_refstring1–500 charactersOptional ticket or pull request reference such as HUM-52 or a URL, up to 500 characters, on one line.

What it returns

Whether a new marker was created and the marker itself: its ID, site, page, change kind, deploy date, note, ticket reference, when it was recorded and whether through a personal token (pat) or a connected app (oauth). It also gives outcome_ready_on, the last day of the 28-day window after the deploy, and outcome_ready, whether complete data has reached that day yet.

Notes

  • Recording the same page, deploy date and change kind again while that marker is active returns the existing marker with created false and changes nothing, even if the note or ticket reference differ. Nightly agents can safely run it again.
  • The page must be the exact URL Search Console reports, including the protocol and any trailing slash. QueryHippo doesn't normalize it, because outcomes are matched to that exact page.
  • Only the site's owner can record changes. A site can have at most 2,000 active markers.
  • The deploy day itself is never counted when outcomes are measured: the before-window ends the day before, and the after-window starts the day after.
  • Changes data: it needs a token or app connection with Read and make changes access. Read-only credentials get an insufficient_scope error.

Description your AI sees

Record that a change shipped on one exact Search Console page on a deploy date (title/meta, content, internal links, technical or other), with an optional note and ticket reference. Idempotent per page, date and kind. Needs change access. QueryHippo measures before and after the deploy date; it does not change your site.

Full schemas

Input schema
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "propertyId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "pattern": "^[a-zA-Z0-9._:-]+$"
    },
    "page": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "change_kind": {
      "type": "string",
      "enum": [
        "title_meta",
        "content",
        "internal_links",
        "technical",
        "other"
      ]
    },
    "deployed_on": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "note": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "external_ref": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "propertyId",
    "page",
    "change_kind",
    "deployed_on"
  ],
  "additionalProperties": false
}

View as Markdown