API Reference
API Reference

List Insight Workflow Executions

List a workflow's execution rows.

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

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 string[] query optional

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

Default []Example status
Item schema
itemsstringrequired
Constant 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 ["id","status","created_at","started_at","priority","session_id","upload_file_id","event_type"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required
Allowed values ["id","status","created_at","started_at","priority","session_id","upload_file_id","event_type"]
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_InsightWorkflowExecutionOutput_ required
5 fields
itemsInsightWorkflowExecutionOutput[]required

List of items returned from the query

Item schema
itemsInsightWorkflowExecutionOutputrequired

Response model for a row in the insight_workflow_execution table.

11 fields
idintegerrequired

Unique ID of the workflow execution row

workflow_idintegerrequired

ID of the workflow this execution belongs to

statusstringrequired

Status of the workflow execution

priorityintegerrequired

Priority of the workflow execution

session_idinteger | nulloptional

Session ID processed by this execution, if applicable

upload_file_idinteger | nulloptional

Upload file ID processed by this execution, if applicable

retry_countintegerrequired

Number of times this execution has been retried

error_messagestring | nulloptional

Error message from the last processing attempt, if any

started_atstring (date-time) | nulloptional

Timestamp at which the most recent processing attempt started

created_atstring (date-time)required

Timestamp at which the execution row was created (i.e. when the work was queued)

event_typestring | nulloptional

Event type that triggered the execution, if applicable

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": [
    {
      "id": 0,
      "workflow_id": 0,
      "status": "string",
      "priority": 0,
      "session_id": "string",
      "upload_file_id": "string",
      "retry_count": 0,
      "error_message": "string",
      "started_at": "string",
      "created_at": "string",
      "event_type": "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"
    }
  ]
}