List top-of-funnel events
curl --request GET \
--url https://api-us.hihobbes.com/api/v1/funnel-events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/funnel-events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-us.hihobbes.com/api/v1/funnel-events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"events": [
{
"id": "<string>",
"eventType": "start_demo_clicked",
"occurredAt": "2023-11-07T05:31:56Z",
"visitorId": "<string>",
"pageViewId": "<string>",
"widgetSessionId": "<string>",
"callId": "<string>",
"sessionRecordingId": "<string>"
}
],
"pagination": {
"total": 248,
"limit": 50,
"offset": 0
}
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}Metrics
List top-of-funnel events
Return pseudonymous action-click and lead-submission events for funnel reporting.
GET
/
api
/
v1
/
funnel-events
List top-of-funnel events
curl --request GET \
--url https://api-us.hihobbes.com/api/v1/funnel-events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/funnel-events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-us.hihobbes.com/api/v1/funnel-events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"events": [
{
"id": "<string>",
"eventType": "start_demo_clicked",
"occurredAt": "2023-11-07T05:31:56Z",
"visitorId": "<string>",
"pageViewId": "<string>",
"widgetSessionId": "<string>",
"callId": "<string>",
"sessionRecordingId": "<string>"
}
],
"pagination": {
"total": 248,
"limit": 50,
"offset": 0
}
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}Requires
analytics:read.
Filter by an ISO 8601 date_from and date_to, then paginate with limit and
offset. Results contain pseudonymous events that help measure drop-off before
a prospect submits an email address.Authorizations
bearerapiKeyHeader
Hobbes API key with the hb_live_ prefix.
Query Parameters
Filter by event time (ISO 8601)
Filter by event time (ISO 8601)
Number of records to return. Defaults to 50 and cannot exceed 200.
Required range:
1 <= x <= 200Zero-based number of records to skip. Use with pagination.total to request the next page.
Required range:
0 <= x <= 1000000