Skip to main content
GET
Get monitoring analysis

Authorizations

Authorization
string
header
required

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

Path Parameters

analysis_id
string
required

Response

id
string
required

Analysis ID.

Example:

"moa_7Hn2kQp9XcLwRt"

run_id
string
required

ID of the monitoring run that produced the analysis.

Example:

"agr_3Fm8vNq1ZsKdYb"

agent_id
string
required

ID of the monitoring agent that produced the analysis.

Example:

"agt_9Lp4wEr6TyUiOa"

customer_id
string
required

ID of the analysed customer.

Example:

"cus_Typ0px2W0aiEtl"

status
enum<string>
required

Analysis status.

  • in_progress: The agent is analysing the customer.
  • completed: The customer was scored.
  • skipped: The agent skipped the customer in this run.
  • failed: The analysis failed.
Available options:
in_progress,
completed,
skipped,
failed
Example:

"completed"

score
number | null
required

Health score between 0 (critical) and 100 (healthy). null when the analysis did not produce a score.

Example:

42

previous_score
number | null
required

Score of the previous analysis of the customer. null for the first analysis.

Example:

58

tier
enum<string> | null
required

Health tier derived from the score and the thresholds the analysis was scored with. null when there is no score.

Available options:
critical,
at_risk,
needs_attention,
healthy
Example:

"at_risk"

summary
string | null
required

Short explanation of the score written by the agent. null when not available.

Example:

"Two invoices overdue for 30+ days and active usage down 40% over the last month."

dimensions
object | null
required

Per-dimension scores the health score is computed from. null when the analysis has no breakdown.

risk_factors
string[] | null
required

Risks identified by the agent. null when none.

Example:
positive_signals
string[] | null
required

Positive signals identified by the agent. null when none.

Example:
hard_rules_triggered
string[] | null
required

Scoring rules that capped the score. null when none were triggered.

Example:

null

created_at
string<date-time>
required

Date the analysis was created.

Example:

"2026-09-28T06:12:44.000Z"