Analytics API Version History

Bubblehouse export APIs use a global incrementing version number, the DataVersion, that sweeps across all export data formats. Whenever any single export format gains an incompatible change, the version increments globally and a new method is introduced for every export API — even those that did not themselves change in that bump. For example, a future incompatible change to the documents export format would produce ListDocuments4 alongside a corresponding ListCustomers4, even though the customer format itself would not have changed.

Older versions remain supported indefinitely. Prior versions are still reachable by direct URL (for example, ListCustomers2) so integrations on the older contract can continue to refer to it, and each deprecated page carries a notice linking to its replacement. For shops onboarded after a version was deprecated, that version is dropped from the sidebar navigation so the docs stay focused on the current format.

New export APIs going forward track these version numbers. Existing deployed APIs that predate the versioning model keep their current method names until they are intentionally rebuilt.

v2 → v3

• Customer ID field renamed. The customer Bubblehouse ID is now emitted as bhid in ListCustomers3. It was previously bh_id in ListCustomers2. All other fields are unchanged.
• ListHistory1 is unchanged in this bump and keeps its deployed method name.
• ListDocuments3 tracks DataVersion3 going forward.