Correlate a submission or record across the pipeline
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/search/correlate/{id} \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/search/correlate/{id}', 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/correlate/{id}"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"correlation_id": "<string>",
"submission": {
"id": "<string>",
"received_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"forward_status": "<string>",
"payload": "<string>"
},
"records": [
{
"id": "<string>",
"dataset": "<string>",
"source": "<string>",
"received_at": "2023-11-07T05:31:56Z"
}
],
"deliveries": [
{
"id": "<string>",
"destination_id": "<string>",
"event_id": "<string>",
"status": "<string>",
"response_code": 123,
"response_ms": 123,
"created_at": "2023-11-07T05:31:56Z"
}
],
"ai_runs": [
{
"id": "<string>",
"trigger_id": "<string>",
"event_id": "<string>",
"status": "<string>",
"model": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}
]
}{
"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>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Search
Correlate a submission or record across the pipeline
Top-level alias: GET /admin/api/search/correlate/. Readable by any role.
GET
/
admin
/
api
/
projects
/
{pid}
/
search
/
correlate
/
{id}
Correlate a submission or record across the pipeline
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/search/correlate/{id} \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/search/correlate/{id}', 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/correlate/{id}"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"correlation_id": "<string>",
"submission": {
"id": "<string>",
"received_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"forward_status": "<string>",
"payload": "<string>"
},
"records": [
{
"id": "<string>",
"dataset": "<string>",
"source": "<string>",
"received_at": "2023-11-07T05:31:56Z"
}
],
"deliveries": [
{
"id": "<string>",
"destination_id": "<string>",
"event_id": "<string>",
"status": "<string>",
"response_code": 123,
"response_ms": 123,
"created_at": "2023-11-07T05:31:56Z"
}
],
"ai_runs": [
{
"id": "<string>",
"trigger_id": "<string>",
"event_id": "<string>",
"status": "<string>",
"model": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}
]
}{
"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>"
}{
"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.
A record id or a submission id. A record id is resolved to its submission first.
Response
The whole chain: the submission (or null when only records matched), every record produced from it, and the deliveries and AI runs keyed off those record ids.