API Reference
API Reference

List Insight Workflow Sessions

List the sessions under a workflow, one row per session, with each tool's results grouped into a `results` dict keyed by tool name.

Sessions come from the workflow's execution queue, so pending, processing and failed sessions show up too, not just completed ones. A session that was queued more than once appears only once. Insights reused from another workflow still show up here.

GET/api/v1/insights/workflows/{workflow_id}/sessions

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

workflow_id integer path required

Query parameters

page integer | null query optional

The page number from which to start (0-based)

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

String names of fields to search. Correspond by index to search field values

Default []Example session_id
Item schema
itemsenum<string>required
Allowed values ["session_id","status"]
search_field_values string[] query optional

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["session_id","status","started_at","created_at"]Example session_id
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_WorkflowSessionRow_ required
5 fields
itemsWorkflowSessionRow[]required

List of items returned from the query

Item schema
itemsWorkflowSessionRowrequired

One session under a workflow: its execution status plus the insight results, grouped by tool name and then by `insight_key in the results` dict.

A session that is still pending, processing, or failed has an empty `results dict; status and error_message` say why.

6 fields
session_idintegerrequired

Session ID

analyzed_atstring (date-time) | nulloptional

When the workflow execution started processing this session; null while the row is still PENDING

queued_atstring (date-time)required

When the session was queued for this workflow

statusstringrequired

Execution status of this session under the workflow

error_messagestring | nulloptional

Error message from the last processing attempt, if any

resultsobjectoptional

Results per tool, keyed by tool name then insight_key. Each insight_key holds a list of values: a single value comes back as a one-item list.

1 field
{key}objectoptional
1 field
{key}unspecified[]optional
Item schema
itemsunspecifiedrequired
pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

The total number of pages of results given the indicated page size

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "session_id": 0,
      "analyzed_at": "string",
      "queued_at": "string",
      "status": "string",
      "error_message": "string",
      "results": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}