Skip to main content

Insights

Analytics and recommendations

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

Ask a natural language question about insights​

POST/api/v1/insights/ask

Request body​

FieldTypeDescription
querystring
contextobject
{
"query": "string",
"context": {}
}

Responses​

200 Insight answer

POST/api/v1/insights/ask

Ask a natural language question about insights

https://api-test.orderly-hub.com/api/v1/insights/ask

Get carrier performance metrics​

GET/api/v1/insights/carriers/performance

Parameters​

NameInRequiredTypeDescription
daysquerynointeger

Responses​

200 Carrier performance data

GET/api/v1/insights/carriers/performance

Get carrier performance metrics

https://api-test.orderly-hub.com/api/v1/insights/carriers/performance

Generate insights for an operation or organization​

POST/api/v1/insights/generate

Request body​

FieldTypeDescription
operationIdstring
scopeoperation | organization | orders
orderIdsarray
typesarray
{
"operationId": "550e8400-e29b-41d4-a716-446655440000",
"scope": "operation",
"orderIds": [
"string"
],
"types": [
"string"
]
}

Responses​

200 Generated insights

POST/api/v1/insights/generate

Generate insights for an operation or organization

https://api-test.orderly-hub.com/api/v1/insights/generate

Get operation insights summary​

GET/api/v1/insights/operations/{operationId}

Parameters​

NameInRequiredTypeDescription
operationIdpathyesstring

Responses​

200 Operation insights summary

GET/api/v1/insights/operations/{operationId}

Get operation insights summary

https://api-test.orderly-hub.com/api/v1/insights/operations/

Acknowledge, resolve, or dismiss an insight​

POST/api/v1/insights/{insightId}/acknowledge

Parameters​

NameInRequiredTypeDescription
insightIdpathyesstring

Request body​

FieldTypeDescription
actionacknowledge | resolve | dismiss
notestring
{
"action": "acknowledge",
"note": "string"
}

Responses​

200 Insight acknowledged

POST/api/v1/insights/{insightId}/acknowledge

Acknowledge, resolve, or dismiss an insight

https://api-test.orderly-hub.com/api/v1/insights//acknowledge