Search records (events)
curl --request POST \
--url https://app.hookie.ai/admin/api/projects/{pid}/search/events \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"dataset": "<string>",
"q": "<string>",
"since": "<string>",
"until": "<string>",
"limit": 25,
"offset": 0
}
'const options = {
method: 'POST',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataset: '<string>',
q: '<string>',
since: '<string>',
until: '<string>',
limit: 25,
offset: 0
})
};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/search/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/search/events"
payload = {
"dataset": "<string>",
"q": "<string>",
"since": "<string>",
"until": "<string>",
"limit": 25,
"offset": 0
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"entity": "events",
"count": 123,
"total": 123,
"limit": 123,
"offset": 123,
"results": [
{
"id": "<string>",
"dataset": "<string>",
"source": "<string>",
"received_at": "2023-11-07T05:31:56Z",
"submission_id": "<string>",
"payload": "<string>"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Search
Search records (events)
Top-level alias: POST /admin/api/search/events. No role above read is enforced. Any non-POST method returns 405.
POST
/
admin
/
api
/
projects
/
{pid}
/
search
/
events
Search records (events)
curl --request POST \
--url https://app.hookie.ai/admin/api/projects/{pid}/search/events \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"dataset": "<string>",
"q": "<string>",
"since": "<string>",
"until": "<string>",
"limit": 25,
"offset": 0
}
'const options = {
method: 'POST',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataset: '<string>',
q: '<string>',
since: '<string>',
until: '<string>',
limit: 25,
offset: 0
})
};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/search/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/search/events"
payload = {
"dataset": "<string>",
"q": "<string>",
"since": "<string>",
"until": "<string>",
"limit": 25,
"offset": 0
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"entity": "events",
"count": 123,
"total": 123,
"limit": 123,
"offset": 123,
"results": [
{
"id": "<string>",
"dataset": "<string>",
"source": "<string>",
"received_at": "2023-11-07T05:31:56Z",
"submission_id": "<string>",
"payload": "<string>"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Authorizations
sessionbearerAuth
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Path Parameters
Project id (UUID) belonging to the caller workspace.
Body
application/json
All filters optional and ANDed. An unparseable body is treated as {}.
Pattern:
^[A-Za-z][A-Za-z0-9_]{0,62}$Case-insensitive (ASCII) substring match against the raw payload JSON.
ISO timestamp; matches received_at >= since.
ISO timestamp; matches received_at <= until.
Required range:
1 <= x <= 200Required range:
x >= 0