API changelog and deprecation policy
How the Privatus Analytics API evolves: additive changes within a version, at least 6 months of notice for breaking changes, and where to follow the changelog.
Compatibility#
The API is generated from the same operations as the app, so new features appear in the API and MCP the day they ship. Within the current version we only make additive changes:
- new operations, new optional inputs, new response fields, new enum values, new webhook events,
- new error
details.
Write clients that ignore unknown fields and handle unknown enum values.
Breaking changes#
Removing or renaming an operation, input or field, or changing its type, is a breaking change. We:
- announce it in the changelog and by email to owners of workspaces whose tokens used the affected operation in the last 90 days,
- keep the old behavior working for at least 6 months,
- mark deprecated operations and fields in the reference and OpenAPI document.
Changelog#
Product and API changes are published on the changelog page of the website, with an RSS feed. Tracker releases also appear as automatic notes on your charts.