Skip to content
SignalSitterDocs

List observations

GET/v1/monitors/{monitorId}/observations

List the beats a monitor has received, newest first, with any measurements they carried.

Authentication
SignalSitter API credential or Clerk session JWT · REST guide
Operation ID
listMonitorObservations

Parameters

Section titled “Parameters”

Path

monitorIdMonitorIdRequired

Immutable public monitor identifier, normally sufficient within the verified organization.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$

Query

jurisdictionMonitorJurisdiction

Optional disambiguator used only when this organization owns the same monitor ID in more than one jurisdiction.

One of
  • "unrestricted"
  • "eu"
  • "us"
  • "fedramp"
includeObservationProvenanceboolean

Include additive observation source-time and provenance fields. Disabled by default so previously generated strict V1 clients remain compatible.

  • Default false
includeObservationBucketsboolean

Include retained aggregate buckets beyond the raw observation window. Independent of observation provenance and disabled by default for previously generated clients. Repeat the selected export format when resuming; bucket capability is preserved by the export cursor.

  • Default false
cursorstring
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._~:/+-]*$
limitinteger
  • Minimum 1
  • Maximum 200
  • Default 50
sincestring

Inclusive RFC 3339 lower bound for accepted observation timestamps.

  • Format date-time
untilstring

Inclusive RFC 3339 upper bound for accepted observation timestamps.

  • Format date-time

Headers

X-Correlation-IDCorrelationId

Optional caller correlation identifier propagated to the response.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

Request body

Section titled “Request body”

No request body.

Responses

Section titled “Responses”
200Successful response
application/jsonMonitorObservationPage
  • Unavailable-evidence refinements apply to every observation in the page, including that no observation both returns and drops the same record.
  • Unavailable-evidence entries name each stored record at most once, carry this contract's own explanation for their reason, and state a recorded engine version exactly when the engine version is the reason and never the version this build runs.
  • Normalized observation outcome refinements apply to every observation in the page.
  • Explicit numeric-rule evidence refinements apply to every observation in the page.
coverageobject
3 properties
availableFromstring
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
availableThroughstring
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
truncatedboolean
Value
  • true
itemsarray of any ofRequired
  • Maximum items 200

Each item

Option 1
acceptedAtstringRequired
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
configurationVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
idstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$
incidentPolicyDecisionobject
13 properties
configurationVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
confirmationobjectRequired
4 properties
confirmedbooleanRequired
observedInWindowintegerRequired
  • Minimum 0
  • Maximum 6
requiredintegerRequired
  • Minimum 1
  • Maximum 6
windowintegerRequired
  • Minimum 1
  • Maximum 6
contributionsarray of objectRequired
  • Maximum items 80

Each item

8 properties
breachobject
7 properties
consequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
justBecameSustainedbooleanRequired
phasestringRequired
One of
  • "clear"
  • "transient"
  • "sustained"
progressobjectRequired
4 properties
elapsedSecondsintegerRequired
  • Minimum 0
  • Maximum 604800
qualifyingObservationsintegerRequired
  • Minimum 0
  • Maximum 10
remainingintegerRequired
  • Minimum 0
  • Maximum 604800
startedAtstring
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
sustainedConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
sustainedCriterionone ofRequired
kind: "observations"
kindstringRequired
Value
  • "observations"
observationsintegerRequired
  • Minimum 1
  • Maximum 10
kind: "elapsed_time"
kindstringRequired
Value
  • "elapsed_time"
secondsintegerRequired
  • Minimum 1
  • Maximum 604800
transientConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
detectorstringRequired
One of
  • "explicit_rule"
  • "adaptive_baseline"
  • "seasonal_baseline"
  • "persistent_shift"
durationSamplesinteger
  • Minimum 0
  • Maximum 1000000
measurementKeystringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
residualScorenumber
  • Minimum 0
ruleIdstring
  • Minimum length 3
  • Maximum length 160
  • Pattern ^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)+$
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
triggerstring
One of
  • "explicit_rule"
  • "extreme_deviation"
  • "moderate_confirmation"
  • "persistent_shift"
engineVersionnumberRequired
Value
  • 1
evaluationobject
3 properties
evaluatedMeasurementKeysarray of stringRequired
  • Maximum items 32

Each item

  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
policyActivebooleanRequired
publishedMeasurementKeysarray of stringRequired
  • Maximum items 32

Each item

  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
explanationstringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
notifiablebooleanRequired
outcomestringRequired
One of
  • "none"
  • "recorded"
  • "confirming"
  • "incident_opened"
  • "incident_sustained"
  • "recovery_pending"
  • "recovery_confirmed"
profileone ofRequired
confirmationRequired: 4
configurednumberRequired
  • Minimum 0
  • Maximum 1
confirmationRequirednumberRequired
Value
  • 4
confirmationWindownumberRequired
Value
  • 6
extremeResidualMultiplenumberRequired
Value
  • 4
namestringRequired
Value
  • "low"
recoveryConfirmationObservationsnumberRequired
Value
  • 4
confirmationRequired: 3
configurednumberRequired
  • Minimum 0
  • Maximum 1
confirmationRequirednumberRequired
Value
  • 3
confirmationWindownumberRequired
Value
  • 5
extremeResidualMultiplenumberRequired
Value
  • 3
namestringRequired
Value
  • "medium"
recoveryConfirmationObservationsnumberRequired
Value
  • 3
confirmationRequired: 2
configurednumberRequired
  • Minimum 0
  • Maximum 1
confirmationRequirednumberRequired
Value
  • 2
confirmationWindownumberRequired
Value
  • 4
extremeResidualMultiplenumberRequired
Value
  • 2.5
namestringRequired
Value
  • "high"
recoveryConfirmationObservationsnumberRequired
Value
  • 3
recoveryobjectRequired
2 properties
confirmedObservationsintegerRequired
  • Minimum 0
  • Maximum 10
requiredObservationsintegerRequired
  • Minimum 1
  • Maximum 10
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
suppressionstring
One of
  • "detector_unconfirmed"
  • "detector_warming"
  • "detector_shadow_mode"
  • "open_incident"
triggersarray of stringRequired
  • Maximum items 4

Each item

One of
  • "explicit_rule"
  • "extreme_deviation"
  • "moderate_confirmation"
  • "persistent_shift"
normalizedMeasurementsarray of object
  • Maximum items 32

Each item

8 properties
definitionobjectRequired
14 properties
disabledRulesarray of string
  • Maximum items 8

Each item

One of
  • "minimum"
  • "maximum"
  • "zero"
  • "nonzero"
  • "absolute_delta"
  • "percentage_delta"
  • "ratio_minimum"
  • "ratio_maximum"
maximumnumber
maximumAbsoluteDeltanumber
  • Minimum 0
maximumPercentageDeltanumber
  • Minimum 0
metricTypestring
One of
  • "gauge"
  • "count"
  • "rate"
  • "duration"
  • "counter"
  • "size"
  • Default "gauge"
minimumnumber
missingPolicystring
One of
  • "skip"
  • "zero"
  • "reject"
  • Default "skip"
modestring
One of
  • "heartbeat"
  • "shadow"
  • "active"
ratioobject
3 properties
denominatorstringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
maximumnumber
minimumnumber
ruleActionobject
2 properties
modestringRequired
One of
  • "inactive"
  • "active"
versionnumberRequired
Value
  • 1
rulePolicyany of
Option 1
consecutiveObservationsinteger
  • Minimum 1
  • Maximum 10
  • Default 1
severitystring
One of
  • "info"
  • "warning"
  • "critical"
  • Default "critical"
Option 2
sustainedConsequencestring
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
  • Default "critical"
sustainedCriterionone of
  • Default {"kind":"observations","observations":1}
kind: "observations"
kindstringRequired
Value
  • "observations"
observationsintegerRequired
  • Minimum 1
  • Maximum 10
kind: "elapsed_time"
kindstringRequired
Value
  • "elapsed_time"
secondsintegerRequired
  • Minimum 1
  • Maximum 604800
transientConsequencestring
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
  • Default "none"
versionnumberRequired
Value
  • 1
transformstring
One of
  • "none"
  • "log1p"
  • Default "none"
unitstring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[^\u0000-\u001F\u007F]*$
zeroExpectationstring
One of
  • "zero"
  • "nonzero"
definitionVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
keystringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
normalizationVersionnumberRequired
Value
  • 1
normalizedValuenumber
originalValuenumber
previousOriginalValuenumber
statusstringRequired
One of
  • "value"
  • "counter_baseline"
  • "counter_reset"
  • "missing_skipped"
  • "missing_zero"
observedAtstring
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
omittedDetailarray of any of
  • Minimum items 1
  • Maximum items 16

Each item

Option 1
One of
  • "normalized_measurements"
  • "adaptive_baseline"
  • "explicit_rule"
  • "incident_policy"
  • "persistent_shift"
  • "seasonal_baseline"
Option 2
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
payloadone ofRequired
kind: "empty"
kindstringRequired
Value
  • "empty"
kind: "number"
kindstringRequired
Value
  • "number"
valuenumberRequired
kind: "measurements"
kindstringRequired
Value
  • "measurements"
valuesobjectRequired
Any keyany of
Option 1
Option 2

Any of

Option 1
Option 2
Option 3
  • Maximum length 256
  • Pattern ^[^\u0000-\u001F\u007F]*$
Keysstring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[^\u0000-\u001F\u007F]*$
provenanceany of
Option 1
One of
  • "live"
  • "historical_import"
Option 2
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
requestIdstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
ruleEvaluationsarray of object
  • Maximum items 32

Each item

20 properties
breachobject
7 properties
consequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
justBecameSustainedbooleanRequired
phasestringRequired
One of
  • "clear"
  • "transient"
  • "sustained"
progressobjectRequired
4 properties
elapsedSecondsintegerRequired
  • Minimum 0
  • Maximum 604800
qualifyingObservationsintegerRequired
  • Minimum 0
  • Maximum 10
remainingintegerRequired
  • Minimum 0
  • Maximum 604800
startedAtstring
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
sustainedConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
sustainedCriterionone ofRequired
kind: "observations"
kindstringRequired
Value
  • "observations"
observationsintegerRequired
  • Minimum 1
  • Maximum 10
kind: "elapsed_time"
kindstringRequired
Value
  • "elapsed_time"
secondsintegerRequired
  • Minimum 1
  • Maximum 604800
transientConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
comparisonstringRequired
One of
  • "at_least"
  • "at_most"
  • "equal"
  • "not_equal"
computedValuenumber
configurationVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
confirmationobjectRequired
3 properties
confirmedbooleanRequired
consecutiveViolationsintegerRequired
  • Minimum 0
  • Maximum 10
requiredintegerRequired
  • Minimum 1
  • Maximum 10
denominatorMeasurementKeystring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
engineVersionany ofRequired
1
Value
  • 1
2
Value
  • 2
explanationstringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
kindstringRequired
One of
  • "minimum"
  • "maximum"
  • "zero"
  • "nonzero"
  • "absolute_delta"
  • "percentage_delta"
  • "ratio_minimum"
  • "ratio_maximum"
measurementKeystringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
normalizationStatusstringRequired
One of
  • "value"
  • "counter_baseline"
  • "counter_reset"
  • "missing_skipped"
  • "missing_zero"
notEvaluatedReasonstring
One of
  • "measurement_missing"
  • "counter_baseline"
  • "counter_reset"
  • "previous_value_missing"
  • "previous_value_zero"
  • "ratio_denominator_missing"
  • "ratio_denominator_zero"
  • "numeric_overflow"
observedValuenumber
policyInputobjectRequired
3 properties
actionablebooleanRequired
modestringRequired
One of
  • "heartbeat"
  • "shadow"
  • "active"
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
referenceValuenumber
ruleIdstringRequired
  • Minimum length 3
  • Maximum length 160
  • Pattern ^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)+$
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
statusstringRequired
One of
  • "passed"
  • "violated"
  • "not_evaluated"
thresholdnumberRequired
transformstringRequired
One of
  • "none"
  • "log1p"
sequenceintegerRequired
  • Greater than 0
  • Maximum 9007199254740991
statusany ofRequired
Option 1
One of
  • "on_time"
  • "late"
  • "not_expected"
  • "learning"
Option 2
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
Option 2
bucketEndedAtstringRequired
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
bucketStartedAtstringRequired
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
measurementsarray of objectRequired
  • Maximum items 32

Each item

7 properties
countintegerRequired
  • Greater than 0
  • Maximum 9007199254740991
flaggedbooleanRequired
lastnumberRequired
maximumnumberRequired
meannumberRequired
measurementKeystringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
minimumnumberRequired
observationCountintegerRequired
  • Greater than 0
  • Maximum 9007199254740991
omittedMeasurementCountinteger
  • Minimum 0
  • Maximum 9007199254740991
resolutionSecondsintegerRequired
  • Greater than 0
  • Maximum 9007199254740991
statusCountsobjectRequired
Any keyinteger
  • Greater than 0
  • Maximum 9007199254740991
Keysany of
Option 1
One of
  • "on_time"
  • "late"
  • "not_expected"
  • "learning"
Option 2
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
typestringRequired
Value
  • "bucket"
nextCursorstring
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._~:/+-]*$
2 response headers
X-Correlation-IDCorrelationIdRequired

Correlation identifier shared by related operations.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
X-Request-IDRequestIdRequired

Request identifier for this response.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
Errors
  • 400Invalid request
  • 401Authentication required
  • 403Permission denied
  • 404Resource not found
  • 429Authentication rate limited
  • 500Internal server error
  • 503Service temporarily unavailable
Error bodyProblemDetails
application/problem+jsonProblemDetails
  • URI references must pass full URI-reference parsing, including percent escapes, authority brackets, and scheme syntax.
  • Documentation links must parse as credential-free HTTPS URLs or root-relative paths.
  • retryAfterSeconds is allowed only when retryable is true.
codestringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^signalsitter\.[a-z][a-z0-9]*(?:[._][a-z0-9]+)*$
correlationIdstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
detailstringRequired
  • Minimum length 1
  • Maximum length 1024
  • Pattern ^[^\u0000-\u001F\u007F]*$
fieldErrorsarray of object
  • Maximum items 32

Each item

3 properties
codestringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[a-z][a-z0-9_]*$
messagestringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
pathstringRequired
  • Maximum length 256

All of

Part 1
  • Pattern ^[^\u0000-\u001F\u007F]*$
Part 2
  • Pattern ^(?:|(?:\/(?:[^~]|~[01])*)+)$
instancestring
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\s\u0000-\u001F\u007F]+$
limitobject
7 properties
attemptedinteger
  • Minimum 0
  • Maximum 9007199254740991
currentinteger
  • Minimum 0
  • Maximum 9007199254740991
dimensionstringRequired
One of
  • "active_monitors"
  • "beat_cadence"
  • "minimum_interval_seconds"
  • "measurements_per_observation"
  • "stored_observations"
  • "observation_retention_seconds"
  • "callback_endpoints"
  • "detector_feature"
  • "api_requests_per_minute"
  • "mcp_requests_per_minute"
  • "service_state"
  • "entitlement_lease"
limitinteger
  • Minimum 0
  • Maximum 9007199254740991
planobject
3 properties
idstringRequired
One of
  • "free"
  • "builder"
  • "smart"
  • "scale"
namestringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$
versionintegerRequired
  • Greater than 0
  • Maximum 9007199254740991
remediationstringRequired
One of
  • "upgrade_plan"
  • "reduce_usage"
  • "increase_interval"
  • "remove_feature"
  • "retry_after_refresh"
  • "contact_support"
  • "export_data"
serviceStatestring
One of
  • "active"
  • "payment_grace"
  • "abuse_suspended"
  • "canceled"
  • "deleting"
remediationarray of object
  • Maximum items 8

Each item

3 properties
codestringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[a-z][a-z0-9_]*$
documentationstring
  • Minimum length 1
  • Maximum length 512

All of

Part 1
  • Pattern ^[^\s\u0000-\u001F\u007F]+$
Part 2
  • Pattern ^(?:\/(?!\/)|[Hh][Tt][Tt][Pp][Ss]:\/\/)
messagestringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
retryablebooleanRequired
retryAfterSecondsinteger
  • Greater than 0
  • Maximum 86400
statusintegerRequired
  • Minimum 400
  • Maximum 599
titlestringRequired
  • Minimum length 1
  • Maximum length 160
  • Pattern ^[^\u0000-\u001F\u007F]*$
typestringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\s\u0000-\u001F\u007F]+$

Operation contract

Section titled “Operation contract”

The operation exactly as it appears in the generated contract. References resolve within the OpenAPI document.

Show raw OpenAPI for listMonitorObservations
{
  "operationId": "listMonitorObservations",
  "parameters": [
    {
      "description": "Optional caller correlation identifier propagated to the response.",
      "in": "header",
      "name": "X-Correlation-ID",
      "required": false,
      "schema": {
        "$ref": "#/components/schemas/CorrelationId"
      }
    },
    {
      "description": "Immutable public monitor identifier, normally sufficient within the verified organization.",
      "in": "path",
      "name": "monitorId",
      "required": true,
      "schema": {
        "$ref": "#/components/schemas/MonitorId"
      }
    },
    {
      "description": "Optional disambiguator used only when this organization owns the same monitor ID in more than one jurisdiction.",
      "in": "query",
      "name": "jurisdiction",
      "required": false,
      "schema": {
        "$ref": "#/components/schemas/MonitorJurisdiction"
      }
    },
    {
      "description": "Include additive observation source-time and provenance fields. Disabled by default so previously generated strict V1 clients remain compatible.",
      "in": "query",
      "name": "includeObservationProvenance",
      "required": false,
      "schema": {
        "default": false,
        "type": "boolean"
      }
    },
    {
      "description": "Include retained aggregate buckets beyond the raw observation window. Independent of observation provenance and disabled by default for previously generated clients. Repeat the selected export format when resuming; bucket capability is preserved by the export cursor.",
      "in": "query",
      "name": "includeObservationBuckets",
      "required": false,
      "schema": {
        "default": false,
        "type": "boolean"
      }
    },
    {
      "in": "query",
      "name": "cursor",
      "required": false,
      "schema": {
        "maxLength": 512,
        "minLength": 1,
        "pattern": "^[A-Za-z0-9][A-Za-z0-9._~:/+-]*$",
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "default": 50,
        "maximum": 200,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Inclusive RFC 3339 lower bound for accepted observation timestamps.",
      "in": "query",
      "name": "since",
      "required": false,
      "schema": {
        "format": "date-time",
        "type": "string"
      }
    },
    {
      "description": "Inclusive RFC 3339 upper bound for accepted observation timestamps.",
      "in": "query",
      "name": "until",
      "required": false,
      "schema": {
        "format": "date-time",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MonitorObservationPage"
          }
        }
      },
      "description": "Successful response",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "400": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Invalid request",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "401": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Authentication required",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "403": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Permission denied",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "404": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Resource not found",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "429": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Authentication rate limited",
      "headers": {
        "Retry-After": {
          "description": "Required retry delay in seconds.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RetryAfterHeader"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "500": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Internal server error",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "503": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Service temporarily unavailable",
      "headers": {
        "Retry-After": {
          "description": "Required retry delay in seconds.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RetryAfterHeader"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    }
  },
  "security": [
    {
      "apiCredential": []
    },
    {
      "clerkSession": []
    }
  ],
  "summary": "List accepted monitor observations newest first using an opaque cursor",
  "tags": [
    "Monitors"
  ]
}
SignalSitter documentation