Log a release
Record what shipped on a website and the day it went live, so a later traffic change can be read against it.
https://api.rankparse.com/v1/releasesFreeAPI key (owner, admin, member or client with edit access)Stores a note about a change: a deploy, a content rewrite, a redesign, a migration or an SEO change. It does not touch the website. Use the UTC day the change was live for its first full day. Call Get a release report once at least seven days have passed.
A release belongs to a host, not to one of your RankParse websites, so it stays when a website is archived and added again.
Body parameters
sitestringrequiredThe website as a host or URL, such as reepl.io or https://www.reepl.io/pricing. It is stored as the bare lowercase host without www.
released_onstringrequiredThe UTC date the change went live, YYYY-MM-DD. It must be a real date and not in the future.
titlestringrequiredA short name for the change, at most 120 characters.
kindstringdefault otherOne of deploy, content, redesign, migration, seo, other.
notesstringWhat changed, at most 1000 characters.
page_containsstringWhen the change only affected some pages, text the page URLs contain, for example /blog/, at most 200 characters. The report then compares only those URLs, in Google Search Console only.
Response
releaseobjectThe stored release: id (use it as release_id), host, released_on, title, kind, notes, page_contains and created_at.
already_loggedbooleanPresent and true when a release with the same host, date and title already existed. That release is returned and the status is 200 instead of 201.
hintstringWhat to do next.
Behavior and limits
- Credits: 0.
- Idempotent: the same host, date and title returns the existing release.
- Limit: at most 200 releases per website host and 2000 per workspace (
400 release_limit). Remove old ones first.
Errors
| HTTP | Code | When |
|---|---|---|
| 400 | invalid_release | The body is not a JSON object, or site, released_on, title, kind, notes or page_contains is missing or invalid, or the date is in the future. |
| 400 | release_limit | The website already has 200 releases, or the workspace 2000. |
| 401 | invalid_api_key | Missing, invalid or revoked API key. |
| 403 | capability_missing | Your role may not edit websites. |
| 429 | rate_limited | More than 60 requests per minute for this key. |
Related
MCP tool: log_release (accepts site, released_on, title, kind, notes, page_contains; safe to repeat).