List Custom Link sessions
curl --request GET \
--url https://api-us.hihobbes.com/api/v1/custom-links/{link_id}/sessions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/custom-links/{link_id}/sessions"
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/custom-links/{link_id}/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"sessions": [
{
"sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "not_opened",
"openedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"engagedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"analysisAvailable": false
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": "Custom Link not found in the key's organization."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}Custom Links
List Custom Link sessions
Return sessions and lifecycle timestamps associated with one Custom Link.
GET
/
api
/
v1
/
custom-links
/
{link_id}
/
sessions
List Custom Link sessions
curl --request GET \
--url https://api-us.hihobbes.com/api/v1/custom-links/{link_id}/sessions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/custom-links/{link_id}/sessions"
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/custom-links/{link_id}/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"sessions": [
{
"sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "not_opened",
"openedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"engagedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"analysisAvailable": false
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": "Custom Link not found in the key's organization."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}Requires
custom_links:read or custom_links:write.
The response contains minimal session references, lifecycle stages, timestamps,
and whether session analysis is available. It does not include transcripts,
visitor identifiers, or prospect metadata. Retrieve full analyzed session
detail with GET /api/v1/sessions/{session_id} and a sessions:read scope.Authorizations
bearerapiKeyHeader
Hobbes API key with the hb_live_ prefix.
Path Parameters
Custom Link UUID.
Query Parameters
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