---
title: "Review"
method: GET
path: "/api/behaviour/review"
tags: ["behaviour"]
---

# Review

`GET /api/behaviour/review`

## Request

- Base URL: `https://api.earmarkiq.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.earmarkiq.app/api/behaviour/review`
- Auth: HTTP bearer

## Response `200`

Successful Response

- ReviewResponse
  - `enabled` boolean, required
  - `has_run` boolean, required
  - `computed_at` string, nullable
  - `top_bills` ReviewStream[]
    - `stream_key` string, required
    - `display` string, required
    - `state` string, required
    - `kind` string, required
    - `scheme` string, nullable
    - `cadence` string, nullable
    - `amount` number, required
    - `monthly_amount` number, required
    - `occurrences` integer, required
    - `last_seen` string, nullable
    - `next_expected` string, nullable
    - `confidence` number, required
    - `evidence` string, required
    - `price_changes` object[]
    - `correction` string, nullable
  - `streams` ReviewStream[]
    - `stream_key` string, required
    - `display` string, required
    - `state` string, required
    - `kind` string, required
    - `scheme` string, nullable
    - `cadence` string, nullable
    - `amount` number, required
    - `monthly_amount` number, required
    - `occurrences` integer, required
    - `last_seen` string, nullable
    - `next_expected` string, nullable
    - `confidence` number, required
    - `evidence` string, required
    - `price_changes` object[]
    - `correction` string, nullable
  - `habits` ReviewHabit[]
    - `habit_key` string, required
    - `display` string, required
    - `category` string, nullable
    - `hits_per_week` number, required
    - `weeks_active` integer, required
    - `monthly_spend` number, required
    - `confidence` number, required
    - `evidence` string, required
    - `correction` string, nullable
  - `trait` ReviewTrait
    - `state` string, required
    - `trait` string, nullable
    - `name` string, nullable
    - `value` number, nullable
    - `confidence` number, nullable
    - `evidence` string, nullable
    - `days_remaining` integer, nullable
    - `pay_cycles_observed` integer, nullable
    - `overdraft_warning_allowed` boolean, nullable
  - `corrections` CorrectionResponse[]
    - `id` string, required
    - `target_type` string, required
    - `target_key` string, required
    - `correction` string, required
    - `locked` boolean, required
    - `note` string, nullable
    - `created_at` string, nullable

---

[API](https://skmtc.dev/earmarkiq/apis/earmark-api.md) · [All operations](https://skmtc.dev/earmarkiq/apis/earmark-api/llms.txt) · [OpenAPI document](https://skmtc.dev/earmarkiq/apis/earmark-api/revisions/4a2c41907105?raw)