Skip to main content
GET
Get an insight

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Path Parameters

insightId
string
required

The insightId a GET /v1/insights row carries.

Example:

"k17a8m2v4w5x6y7z8a9b0c1d2e3f4g5h"

Response

The finding.

insightId
string
required
title
string
required

What the finding is about.

description
string
required

The detector’s deterministic headline; quote it, never restate its numbers.

severity
enum<string>
required
Available options:
critical,
warning,
opportunity,
info
confidence
enum<string>
required
Available options:
high,
medium,
low
kind
enum<string>
required

answer reports what happened, insight a change that passed its statistical test, strategy a recommended next step.

Available options:
answer,
insight,
strategy
category
string
required
detectorId
string
required
state
enum<string>
required

A snooze that has ended reads as active.

Available options:
active,
snoozed,
cleared,
dismissed,
resolved,
stale
firstSeenAt
string<date-time>
required
lastSeenAt
string<date-time>
required
recurrenceCount
integer
required
Required range: x >= 0
url
string
required

The finding’s page in Brew.

rationale
string | null
required
closedReason
string | null
required
closedAt
string<date-time> | null
required
lastActedAt
string<date-time> | null
required
churnCount
integer
required

How often the finding has closed and reopened.

Required range: x >= 0
metrics
object
required

Frozen when the finding was computed: the only numbers to quote about it.

evidence
object[]
required
subject
object
required

What the finding is about: a send, an automation, a domain.

method
object | null
required

How the detector works; null when none is recorded.

generatedBy
object | null
required

The engine run that last produced the finding.

freshness
object
required
action
object