Get User Event Segmentation

Description: This endpoint takes event name and filters and returns the users that match the specified filters.

Parameters:

• period: The start and end dates. If not provided, the last 30 days will be used.
• event_name: The event name. This is the name of the event that you want to segment.
• language: The language. Use country code (ex: ‘en’, ‘ru’, ‘es’, etc.)
• is_premium: Whether the user is premium
• model: The model of the device that the user is using
• os: The operating system of the device that the user is using
• total_sessions: Filter on the minimum number of sessions
• total_events: Filter on the minimum number of events
• limit: The number of items per page (max 100)
• offset: The number of items to skip (default 0)

Header

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

Returns:

• UserEventSegmentationResponse: The response containing the user event segmentation data. It contains the following fields:
  • data: The list of user event segmentation entries. It contains the following fields:
    • telegram_id: The Telegram ID of the user.
    • language: The language of the user. Defaults to None.
    • is_premium: Whether the user is premium. Defaults to False.
    • model: The model of the user. Defaults to None.
    • os: The operating system of the user. Defaults to None.
    • country: The country of the user. Defaults to None.
    • total_sessions: The total number of sessions of the user.
    • total_events: The total number of events of the user.
    • last_active_at: The last active date of the user.