Correlate any pipeline id across the pipeline
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{project_id}/search/correlate/{id} \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/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/{project_id}/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",
"payload": "<string>",
"payload_length": 123,
"payload_truncated": true
}
],
"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",
"error": "<string>"
}
],
"matched": "record",
"workflow_runs": [
{
"id": "<string>",
"workflow_id": "<string>",
"workflow_name": "<string>",
"state": "pending",
"current_step_index": 123,
"last_error": "<string>",
"record_id": "<string>",
"engine": "cf",
"run_attempt": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"steps": [
{
"index": 123,
"path": "<string>",
"type": "<string>",
"status": "running",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"details": {}
}
]
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}Search
Correlate any pipeline id across the pipeline
Top-level alias: GET /admin/api/search/correlate/. Readable by any role.
GET
/
admin
/
api
/
projects
/
{project_id}
/
search
/
correlate
/
{id}
Correlate any pipeline id across the pipeline
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{project_id}/search/correlate/{id} \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/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/{project_id}/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",
"payload": "<string>",
"payload_length": 123,
"payload_truncated": true
}
],
"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",
"error": "<string>"
}
],
"matched": "record",
"workflow_runs": [
{
"id": "<string>",
"workflow_id": "<string>",
"workflow_name": "<string>",
"state": "pending",
"current_step_index": 123,
"last_error": "<string>",
"record_id": "<string>",
"engine": "cf",
"run_attempt": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"steps": [
{
"index": 123,
"path": "<string>",
"type": "<string>",
"status": "running",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"details": {}
}
]
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}Authorizations
sessionbearerAuthapiKey
Path Parameters
Response
The whole chain: the submission (or null when only records matched), every record produced from it with a preview of its payload, the deliveries (destination, status, error) and AI runs (with their error) keyed off those record ids, and the workflow runs those records started, each with its per-step status.