API Reference
API Reference

Insights List

List the evaluated insights for sessions.

GET/api/v1/insights/

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

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 name
Item schema
itemsenum<string>required
Allowed values ["id","session_id","upload_file_id","workflow_id","upload_folder_id","insight_key","insight_tool_id"]
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","session_id","upload_file_id","workflow_id","upload_folder_id","insight_key","insight_tool_id"]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","session_id","upload_file_id","workflow_id","upload_folder_id","insight_key","insight_tool_id"]
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_InsightsOutput_ required
5 fields
itemsInsightsOutput[]required

List of items returned from the query

Item schema
itemsInsightsOutputrequired

Response model for an insight tool.

13 fields
idintegerrequired

Unique ID of the insight

session_idinteger | nulloptional

Unique ID for the session

upload_file_idinteger | nulloptional

Unique ID for uploaded file

insight_tool_idintegerrequired

Unique ID for insight tool configuration

insight_tool_versionintegerrequired

Version of insight tool configuration

workflow_idinteger | nulloptional

Insight workflow that produced this row, if applicable

insight_keystringrequired

Key for insight tool result

string_valuestring | nulloptional

String value of insight tool result

numeric_valuenumber | nulloptional

Numeric value of insight tool result

json_valueobjectrequired

JSON value of insight tool result

1 field
{key}string | integer | numberoptional
3 options
Option 1stringoptional
Option 2integeroptional
Option 3numberoptional
created_atstring (date-time)optional

Timestamp at which insight tool result was created

updated_atstring (date-time)optional

Timestamp at which insight tool result was last updated

upload_file_metadataunspecifiedoptional

Metadata associated with the uploaded file

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,
      "session_id": "string",
      "upload_file_id": "string",
      "insight_tool_id": 0,
      "insight_tool_version": 0,
      "workflow_id": "string",
      "insight_key": "string",
      "string_value": "string",
      "numeric_value": "string",
      "json_value": "string",
      "created_at": "string",
      "updated_at": "string",
      "upload_file_metadata": "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"
    }
  ]
}