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

Field	Type	Description
query	string
context	object

{
  "query": "string",
  "context": {}
}

Responses

200 Insight answer

POST/api/v1/insights/ask

Ask a natural language question about insights

API key (Bearer token)

Request body (JSON){ "query": "string", "context": {} }

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

Get carrier performance metrics

GET/api/v1/insights/carriers/performance

Parameters

Name	In	Required	Type	Description
days	query	no	integer

Responses

200 Carrier performance data

GET/api/v1/insights/carriers/performance

Get carrier performance metrics

API key (Bearer token)

days (query)

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

Field	Type	Description
operationId	string
scope	operation | organization | orders
orderIds	array
types	array

{
  "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

API key (Bearer token)

Request body (JSON){ "operationId": "550e8400-e29b-41d4-a716-446655440000", "scope": "operation", "orderIds": [ "string" ], "types": [ "string" ] }

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

Get operation insights summary

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

Parameters

Name	In	Required	Type	Description
operationId	path	yes	string

Responses

200 Operation insights summary

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

Get operation insights summary

API key (Bearer token)

operationId * (path)

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

Acknowledge, resolve, or dismiss an insight

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

Parameters

Name	In	Required	Type	Description
insightId	path	yes	string

Request body

Field	Type	Description
action	acknowledge | resolve | dismiss
note	string

{
  "action": "acknowledge",
  "note": "string"
}

Responses

200 Insight acknowledged

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

Acknowledge, resolve, or dismiss an insight

API key (Bearer token)

insightId * (path)

Request body (JSON){ "action": "acknowledge", "note": "string" }

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