Events API
Get Events Segmentation
Events API
Get Events Segmentation
Description: Retrieves events segmentation based on the specified start and end dates.
Parameters:
period: The start and end dates- event (str): The event
mode: The modefilters: List of filters in Amplitude-like formatgroup_by: The group by
Header
x-api-key: Your API Key (Dashboard->Settings)
Returns:
EventSegmentationResponse: The transformed events segmentation data.
Raises:
HTTPException: If an error occurs during the retrieval process.
GET
Authorizations
Your API Key (Dashboard->Settings)
Query Parameters
Event name you want to segment on
Mode of the event segmentation (uniques or totals)
Available options:
uniques, totals List of fields to group by
Available options:
is_premium, language, referrer_type, os, brand, model, country, write_access Start date in YYYYMMDD format
End date in YYYYMMDD format
Segments in Amplitude-like format. Example used: [{"prop":"country","op":"is","values":["United States"]}]
Response
200 - application/json