Versioning and support

The Reporting API contract starts at /api/v1/reporting. Within v1, clients must tolerate new optional parameters, response fields, and endpoints. Ignore fields you do not recognise.

A breaking contract change requires a new major API version. A retiring endpoint carries Deprecation and Sunset headers for at least 90 days before removal.

Supported integration surface

The supported customer surface is the six documented read-only reporting endpoints, the public MCP OAuth protocol, and the six MCP tools. Dashboard account management, billing, QA utilities, administrative operations, provider configuration, and internal jobs are outside this contract.

Download the public OpenAPI document to build client integrations. Its endpoint allowlist is checked during the documentation build. The full application schema is not the public integration specification.

Before moving to production

• Use the correct environment’s endpoint and credentials.
• Verify the organisation and team restrictions with synthetic staging data.
• Handle empty results, pagination, nullable fields and rate limits.
• Keep credentials on the server or in your MCP client’s secure credential store.
• Reconnect OAuth clients after a resource URL changes.

For account or integration help, use the support contact available in your BrandVisibility dashboard. Include a request ID and a minimal redacted reproduction.