Get User Segmentation

Description: Retrieves user information based on the specified filters.

Parameters:

• language: The language. Use country code (ex: ‘en’, ‘ru’, ‘es’, etc.)
• utm: The start parameter
• is_premium: Whether the user is premium
• country: The country
• city: The city
• wallet_connected: Whether the user has a wallet connected
• wallet_address: The wallet address
• wallet_balance: The wallet balance
• wallet_volume: The wallet volume
• wallet_provider: The wallet provider
• sort_by: The field to sort by
• sort_order: The order to sort by
• limit: The number of items per page
• offset: The number of items to skip

Header

• x-api-key: Your API Key (Dashboard->Settings)

Returns:

• UserSegmentationResponse: The response containing the user segmentation data. It contains the following fields:
  • data: The list of user segmentation entries. It contains the following fields:
    • telegram_id: The Telegram ID of the user.
    • language: The language of the user. Defaults to None.
    • utm: The start parameter of the user. Defaults to None.
    • is_premium: Whether the user is premium. Defaults to False.
    • first_active_at: The first active date of the user.
    • country: The country of the user. Defaults to None.
    • city: The city of the user. Defaults to None.
    • total_events: The total number of events from the user in your application.
    • total_sessions: The total number of sessions from the user in your application.
    • address: The wallet address of the user. Defaults to None.
    • provider: The wallet provider of the user. Defaults to None.
    • curr_balance: The current balance of the user’s wallet. Defaults to 0.
    • curr_volume: The current volume of the user’s wallet. Defaults to 0.
  • limit: The number of items per page.
  • offset: The number of items to skip.
  • status_code: The status code of the response.
  • message: The message of the response.

Raises:

• HTTPException: If an error occurs during the retrieval process.