GET
/
events
/
segmentation
Get Events Segmentation
curl --request GET \
  --url https://ebn.telemetree.io/public-api/events/segmentation \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "series": [
      [
        123
      ]
    ],
    "seriesLabels": [
      "<string>"
    ],
    "seriesCollapsed": [
      [
        {
          "value": 123
        }
      ]
    ],
    "xValues": [
      "<string>"
    ],
    "filters": []
  }
}

Authorizations

​
x-api-key
string
header
required

Your API Key (Dashboard->Settings)

Query Parameters

​
event
string
required

Event name you want to segment on

​
mode
enum<string>
required

Mode of the event segmentation (uniques or totals)

Available options:
uniques,
totals
​
group_by
enum<string>[] | null

List of fields to group by

​
start
string
required

Start date in YYYYMMDD format

​
end
string
required

End date in YYYYMMDD format

​
segments
string[] | null

Segments in Amplitude-like format. Example used: [{"prop":"country","op":"is","values":["United States"]}]

Response

Successful Response

​
data
object
required