---
title: "Insights List"
method: GET
path: "/api/v1/insights/"
tags: ["insights"]
---

# Insights List

`GET /api/v1/insights/`

List the evaluated insights for sessions.

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` InsightsProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — 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
- `order_by` 'id' | 'session_id' | 'upload_file_id' | 'workflow_id' | 'upload_folder_id' | 'insight_key' | 'insight_tool_id'
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` InsightsProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseInsightsOutput
  - `items` InsightsOutput[], required — List of items returned from the query
    - `id` integer, required — Unique ID of the insight
    - `session_id` integer, nullable — Unique ID for the session
    - `upload_file_id` integer, nullable — Unique ID for uploaded file
    - `insight_tool_id` integer, required — Unique ID for insight tool configuration
    - `insight_tool_version` integer, required — Version of insight tool configuration
    - `workflow_id` integer, nullable — Insight workflow that produced this row, if applicable
    - `insight_key` string, required — Key for insight tool result
    - `string_value` string, nullable — String value of insight tool result
    - `numeric_value` number, nullable — Numeric value of insight tool result
    - `json_value` object, required — JSON value of insight tool result
    - `created_at` string, date-time — Timestamp at which insight tool result was created
    - `updated_at` string, date-time — Timestamp at which insight tool result was last updated
    - `upload_file_metadata` unknown
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/revisions/534f1f22c775/schema)