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>",
"request": {
"method": "POST",
"headers": {
"x-github-event": "push",
"user-agent": "GitHub-Hookshot/abc",
"authorization": "[redacted]"
},
"query": "topic=orders",
"content_type": "<string>",
"source_ip": "<string>"
},
"endpoint_id": "<string>",
"dedup_source": "idempotency-key"
},
"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",
"destination_name": "<string>",
"dataset": "<string>",
"attempts": 123,
"next_retry_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"updated_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"
}
],
"matched": "record",
"workflow_runs": [
{
"id": "<string>",
"workflow_id": "<string>",
"workflow_name": "<string>",
"state": "<string>",
"record_id": "<string>",
"created_at": "<string>"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}Correlate any pipeline id across the pipeline
Top-level alias: GET /admin/api/search/correlate/. Readable by any role.
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>",
"request": {
"method": "POST",
"headers": {
"x-github-event": "push",
"user-agent": "GitHub-Hookshot/abc",
"authorization": "[redacted]"
},
"query": "topic=orders",
"content_type": "<string>",
"source_ip": "<string>"
},
"endpoint_id": "<string>",
"dedup_source": "idempotency-key"
},
"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",
"destination_name": "<string>",
"dataset": "<string>",
"attempts": 123,
"next_retry_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"updated_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"
}
],
"matched": "record",
"workflow_runs": [
{
"id": "<string>",
"workflow_id": "<string>",
"workflow_name": "<string>",
"state": "<string>",
"record_id": "<string>",
"created_at": "<string>"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>"
}Authorizations
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, submission, delivery or AI run id. A record id is resolved to its submission; a delivery or AI run id to the record it belongs to (a replay's #replay:<n> suffix is ignored) and then to its submission.
Response
The whole chain: the submission (or null when only records matched), every record produced from it, and the deliveries, AI runs and workflow runs keyed off those record ids.
The resolved submission id.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Which kind of id was looked up.
record, submission, delivery, ai_run Workflow runs these records started (a run's correlation_id is its entry record's id), oldest first, at most 100 (#196).
Show child attributes
Show child attributes