Early Access
This endpoint & its output may change at any time without notice. If you're using this, let us know so that we can talk to you if/when we plan to make changes.
Use this endpoint to retrieve raw run data from your users (both contacts and anonymous users).
Example response
{
"total": 69234,
"sessions": [
{
"id": ":uuid",
"type": "visit|visit-multiple|interaction",
"started": ":datetime",
"ended": ":datetime",
"run_count": 5,
"app_count": 1,
"runs": [
{
"id": ":datetime",
"access_type": "api|app|embed",
"is_initial_run": false,
"input_parameters": {
"fx": "0.92",
"usd": "100"
},
"created": ":datetime",
"has_custom_values": false,
"app": {
"id": ":app_uuid",
"app_identifier": ":organization_slug/:external_id/:app_slug",
"name": ":app_name"
}
},
…
],
"contact": {
"id": ":contact_uuid",
"email": ":email" | null,
"created_at": ":datetime",
"updated_at": ":datetime" | null,
"identified_at": ":datetime" | null,
"first_seen_at": ":datetime",
"last_seen_at": ":datetime",
"image": ":url" | null,
"properties": [
// See the Contacts endpoint documentation
],
"identifiers": [
// See the Contacts endpoint documentation for more info
{
"service": "hubspot",
"identifier": "3f920989e8820bbb5459f8229d2b3d10",
"type": "tracking"
}
]
}
},
],
"next": "/v1/contacts?page=2",
"previous": null
}
Filtering sessions
You can filter sessions on these parameters:
from_date
only include sessions that were active after this date- Warning! This filters sessions on their end time, meaning earlier runs in the same session can still have happened before the
from_date
- Warning! This filters sessions on their end time, meaning earlier runs in the same session can still have happened before the
to_date
only include sessions that were active before this date- Warning! This filters sessions based on their start time, meaning later runs in the same session can have happened after the
to_date
- Warning! This filters sessions based on their start time, meaning later runs in the same session can have happened after the
app
only include sessions that included runs for this app- This accepts both app UUID's and app identifiers
contact
only include sessions for this contact- This accepts both contact UUID's and identifiers in the string format:
service:type:identifier
- To search for email, you can use
?contact=summit:email:[email protected]
or[email protected]
for short, assummit
is the default service andtype
can be auto-guessed from the identifier. - To search by HubSpot UTK, you can use
?contact=hubspot:tracking:your-hutk-cookie
- To search for email, you can use
- This accepts both contact UUID's and identifiers in the string format: