Skip to content

CHANGELOG.md

Latest commit

 

History

History
63 lines (48 loc) · 2.6 KB

CHANGELOG.md

File metadata and controls

63 lines (48 loc) · 2.6 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[3.0.0] - 2026-03-10

BREAKING CHANGES

  • Removed API Secret (Project Secret) authentication support
    • Project Secret authentication has been deprecated and will be fully retired by Mixpanel on March 3, 2027
    • All users must migrate to Service Account authentication
    • The api_secret parameter has been renamed to service_account_password
    • The following parameters are now REQUIRED:
      • service_account_username - Your Service Account username
      • service_account_password - Your Service Account password/secret
      • project_id - Your Mixpanel project ID
    • Attempting to initialize without these required parameters will raise a ValueError

Migration Guide

Old initialization (no longer supported):

mputils = MixpanelUtils('project_api_secret', token='token')

New initialization (required):

mputils = MixpanelUtils(
    service_account_username='my-user.12345.mp-service-account',
    service_account_password='service_account_password_here',
    project_id=project_id_here,
    token='project_token_here'
)

To create a Service Account, visit your Mixpanel project settings or refer to the Service Accounts documentation.

Changed

  • Parameter order changed to prioritize Service Account credentials:
    1. service_account_username (required)
    2. service_account_password (required, formerly api_secret)
    3. project_id (required)
    4. token (optional, required for imports)
    5. Other optional parameters...
  • Invalid or missing required parameters now raise ValueError instead of triggering assertions.
  • Added pytest test suite for MixpanelUtils.__init__ Service Account authentication requirements, including rejection of legacy API Secret-only usage.
  • Added pytest test suite for URL construction across all supported API endpoints and regions.
  • Corrected the README example script link to point to tools/mixpanel_utils_example.py.

Removed

  • Support for Project Secret (API Secret) authentication
  • Conditional logic for Service Account vs API Secret authentication

[2.2.7] - Previous Release

  • Including group analytic operations
  • Add support for India Residency
  • Various bug fixes and improvements