Skip to content
GOCUX
Documentation
GOCUX / Documentationmonitor api

Establish a monitoring baseline

Create an initial evidence record before interpreting later changes.

Create an initial evidence record before interpreting later changes.

Practical procedure

  1. Select a stable source set and capture the document versions or effective dates relevant to the objective.
  2. Approve the monitor definition and inspect its first completed occurrence. Record supported values and their citations rather than treating an empty starting set as a meaningful baseline.
  3. Compare a later occurrence with the initial evidence. Separate a changed value from changed support, unavailable material and an incomplete run.

Define an evidence-backed Pulse monitor

Pulse monitors track an objective against selected Knowledge sources. A definition records cadence, timezone, source policy, materiality rule and notification mode. Review and approve the exact definition version before running it. An occurrence records a particular run; it is distinct from the monitor definition and from any resulting email delivery.

Contract example

Developer examples below describe routes on an authorized, configured GoCux control-plane base URL. They are request shapes or operation references, not claims that a particular public hostname exposes the API. Use the workspace for the corresponding human workflow; availability and permissions depend on the actual deployment.

GET /pulse/monitors?projectId=project-id — inspect available monitor definitions

GET /pulse/monitors/{monitor_id}
GET /pulse/monitors/{monitor_id}/occurrences
GET /pulse/occurrences/{occurrence_id}

Inspect the result

Inspect occurrence state and available evidence before reporting a change. A new or missing source passage can change the support for a value even when the displayed value is unchanged. Notification mode can be none or email; choosing email is not evidence that delivery is configured or that a message reached its recipient.

What to keep explicit

A baseline inherits the limits of the evidence available at that time. A later source addition can explain a difference without proving the underlying real-world condition changed.

Handle incomplete and refused work

Creation requires at least one unique Knowledge source identifier. Decisions and transitions use explicit version checks and Idempotency-Key. A stale definition or a monitor that is not active can return 409. A 503 is unavailable monitor storage or materialization, not a statement that nothing changed. Pause or archive intentionally when the monitoring objective ends.

Bring this workflow into your workspace.

Set the scope. Review the evidence. Approve the steps that need it.

Open the workspace

Keep exploring