TRANXACT.AI Help

Platform · Health

System Traces

One process in full: every statement it sent with timings, the locks it holds and waits on, who it blocks and who blocks it, and the plan of what it is running. The slowest recent work and the statements with the most database time.

Type REST2 operationsBase path /api/platform/monitor-traces

Download specification (OpenAPI 3.1) Screen: System Traces

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Platform › System Traces on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

2 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/monitor-tracesRead system traces

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/monitor-traces" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/monitor-traces/{id}Read system traces

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/monitor-traces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › System Traces for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.