How changes are made
The API is versioned in its path: https://dashboard.perfbee.com/api/v1. Inside version v1 a change only adds. These are additions and never break a client that follows the rules below.
- A new endpoint.
- A new optional parameter or request field.
- A new member in an answer, a new value of an existing enum, a new error code, a new webhook event and a new member in a webhook body.
These are breaking changes. They never happen inside v1.
- Removing or renaming an endpoint, a parameter or a member.
- Changing the type or the meaning of a member.
- Making an optional parameter required.
- Removing a value of an enum or an error code.
A client must ignore members and enum values it does not know, and must treat an error code it does not know by its status. The committed OpenAPI file is the contract. It is built from the code, and a test fails when the code and the file differ.
Limits are not part of the contract. The numbers on the rate limits page are the current ones.
Deprecation
A breaking change ships as a new version under /api/v2. Both versions run side by side for at least six months. During that time the old version keeps working, and an endpoint or member that is going away answers with a Deprecation header and a Sunset header that carries the date it stops.
Releases
| Version | Date | Change |
|---|---|---|
| 1.0.0 | November 4, 2026 | The first release: 31 operations in 6 groups (Account, Crawls, Issues, Pages, Crawl control, Webhooks), problem documents, cursor lists, signed webhooks. |
The release number follows the OpenAPI file: it goes up when something is added. A bug fix does not change it.