Versioning
The Partner API is versioned in the URL. The current version is:
https://partner-api.performancehub.co/partner/v1/
Change policy
Performance Hub aims to make additive, backward-compatible changes wherever possible.
Examples of backward-compatible changes:
- Adding a new optional field to a request.
- Adding a new field to a response.
- Adding a new endpoint.
- Adding a new enum value where clients are expected to handle unknown values.
- Improving validation messages without changing the status code contract.
access_time_windows and access_time_windows_revision are additive Member request fields. Existing clients that omit them keep the stored Access Time Window snapshot unchanged. This omission rule preserves partial-upsert compatibility; omission is not equivalent to sending an empty array.
Examples of breaking changes:
- Removing or renaming a field.
- Changing the type of a field.
- Making an optional request field required.
- Removing an endpoint.
- Changing the meaning of an existing status code or domain-specific
reason.
Deprecations
When a breaking change is required, Performance Hub will avoid changing the existing version in place where possible. Instead, we will introduce a new version or migration path and communicate the change to affected partners.
Deprecation notices can include:
- A changelog entry.
- Direct partner communication.
- Notes in the Partner Console.
- Migration guidance in the docs.
Client recommendations
Build clients that tolerate additive changes:
- Ignore response fields you do not use.
- Treat unknown enum values as unsupported rather than crashing.
- Avoid strict response equality checks.
- Log unrecognized values so you can update your integration intentionally.
For revisioned Member partitions such as Access Time Windows, persist the submitted revision and normalized payload until the outcome is known. Reusing a revision for changed content is a conflict, while replaying the same content is idempotent. See Access Time Windows.
OpenAPI specifications
Use the published OpenAPI specifications to generate clients, validate requests, and track API shape changes over time.