Docs

List insights

GET /api/v1/programmatic/insights

GET/api/v1/programmatic/insights
Insightsv1insights:read

Returns generated insights for the required YYYY-MM period.

Parameters

NameInType Description
account_idsqueryarray<string>Optional Restrict insights to these account identifiers. At most 100 values. <account_ids>
periodquerystringRequired Required financial month in `YYYY-MM` format. 2026-07

Code examples

curl --request GET \
  --url 'https://api.tetri.app/api/v1/programmatic/insights?account_ids=<account_ids>&period=2026-07' \
  --header 'Authorization: Bearer $TETRI_API_TOKEN'

Responses

200Generated insights, response timestamp, and the next planned refresh time.
{
  "insights": [
    {
      "id": "anomaly_018f8e30-66fd-7e50-a1ef-9c52d11c2baf",
      "type": "anomaly",
      "priority": "high",
      "triggered_at": "2026-07-15T06:03:00.000Z",
      "entity_id": "<uuid>",
      "associated_transaction_id": "<uuid>",
      "payload": {}
    }
  ],
  "generated_at": "2026-07-12T12:00:00Z",
  "next_refresh_at": "2026-07-12T12:00:00Z"
}
400Request parameters or payload failed validation. Inspect `code` and `message`.
{
  "statusCode": 400,
  "code": "PROGRAMMATIC_PAGINATION_MODE_CONFLICT",
  "message": "<string>",
  "error": "Bad Request",
  "request_id": "8cf64dcc-0f73-4f8d-a845-3d80c1040475"
}
401The personal access token is missing, invalid, expired, or revoked.
{
  "statusCode": 400,
  "code": "PROGRAMMATIC_PAGINATION_MODE_CONFLICT",
  "message": "<string>",
  "error": "Bad Request",
  "request_id": "8cf64dcc-0f73-4f8d-a845-3d80c1040475"
}
403The token lacks the required scope or no longer has workspace access.
{
  "statusCode": 400,
  "code": "PROGRAMMATIC_PAGINATION_MODE_CONFLICT",
  "message": "<string>",
  "error": "Bad Request",
  "request_id": "8cf64dcc-0f73-4f8d-a845-3d80c1040475"
}
429The credential exceeded its request rate limit.
{
  "statusCode": 400,
  "code": "PROGRAMMATIC_PAGINATION_MODE_CONFLICT",
  "message": "<string>",
  "error": "Bad Request",
  "request_id": "8cf64dcc-0f73-4f8d-a845-3d80c1040475"
}