Skip to main content
GET
/
insights
List Insights
curl --request GET \
  --url http://0.0.0.0:8000/insights \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "name": "<string>",
      "description": "<string>",
      "supporting_events": [
        "<string>"
      ],
      "query": {},
      "query_raw": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "page": 2,
  "size": 2,
  "total": 1,
  "pages": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
organization_id
string<uuid> | null

The organization ID to list insights for. Defaults to the active organization from the JWT if omitted.

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

​
items
InsightResponse · object[]
required
​
page
integer | null
required
Required range: x >= 1
​
size
integer | null
required
Required range: x >= 1
​
total
integer | null
Required range: x >= 0
​
pages
integer | null
Required range: x >= 0