For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Transaction check data to add.
check_idstringRequired
Unique identifier for a monitoring check belonging to a transaction. This is the primary key for a transaction check and should be unique across all transaction checks. Updates to a transaction check should be made using this identifier.
statusenumRequired
Allowed values:
typeenumRequired
The type of monitoring check that is being performed.
Allowed values:
timestampdatetimeRequired
The time of the transaction check. This should be in ISO 8601 format. When adding a new transaction check, this field represents the creation time. When updating a transaction check, this represents the time of the update.
related_tx_idstringOptional
Unique identifier for the transaction for which the check is related to.
additional_propertieslist of objectsOptional
Additional metadata that relates to a transaction check.
Response
Transaction check added successfully
check_idstring
Unique identifier for a monitoring check belonging to a transaction. This is the primary key for a transaction check and should be unique across all transaction checks. Updates to a transaction check should be made using this identifier.
timestampdatetime
The time of the transaction check. This should be in ISO 8601 format. When adding a new transaction check, this field represents the creation time. When updating a transaction check, this represents the time of the update.
statusenum
Allowed values:
typeenum
The type of monitoring check that is being performed.
Allowed values:
related_tx_idstring
Unique identifier for the transaction for which the check is related to.
additional_propertieslist of objects
Additional metadata that relates to a transaction check.
