Get event property breakdown REST API
GET
/api/sites/{id}/events/breakdown
const url = 'https://app.hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events/breakdown?event_name=example&property_key=example';const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://app.hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events/breakdown?event_name=example&property_key=example' \ --cookie hk_token=<hk_token>Returns distinct property values for one event property key, ordered by session count.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Query Parameters
Section titled “Query Parameters”from
string format: date-time
to
string format: date-time
event_name
required
string
property_key
required
string
Responses
Section titled “Responses”Event property breakdown
Media typeapplication/json
Array<object>
object
name
string
value
integer
Examplegenerated
[ { "name": "example", "value": 1 }]