TRANXACT.AI Help

Platform · Published API

API Call Log

Every call to the published API, allowed or refused, with the reason for each refusal. A call that came with no key, or a key nobody issued, is logged refused with the Client column empty: that includes anyone probing the address and an AI app's first call before it has signed in. To see how your own integrations are doing, filter on Client. This is not the audit log — that records what the record actually did, because a published call goes through the ordinary route and the ordinary route audits itself. This records what was asked, from where, and by which key.

Type REST6 operationsBase path /api/platform/api-callsPublished as /api/v1/api-calls

Download specification (OpenAPI 3.1) Screen: API Call Log

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 › API Call Log 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.
Tableplatform.api_calls · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/platform/api-callsList api call log

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "1250.00",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "exposure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "at": "2026-10-30T09:00:00Z",
      "protocol": "text",
      "method": "text",
      "path": "text",
      "tool_name": "Example",
      "module_key": "text",
      "resource_key": "text",
      "status": 10,
      "outcome": "text",
      "refusal": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/platform/api-calls?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/api-calls/{id}Read one api call

Path parameters

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

Response 200

{
  "id": "1250.00",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "exposure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "at": "2026-10-30T09:00:00Z",
  "protocol": "text",
  "method": "text",
  "path": "text",
  "tool_name": "Example",
  "module_key": "text",
  "resource_key": "text",
  "status": 10,
  "outcome": "text",
  "refusal": "text"
}

404 when no record with that id is visible to the caller.

Sample request

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

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/api-calls" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/api-calls/{id}/copyCopy

Path parameters

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

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/api-calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/platform/api-calls/{id}Put api call log

Path parameters

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

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/api-calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/api-calls/{id}Delete api call log

Path parameters

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

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

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

Data model

Every field of a api call, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
idbigintread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
client_iduuidread onlyClient id
exposure_iduuidread onlyExposure id
attimestamp with time zoneread onlyAt
protocoltextread onlyProtocol
methodtextread onlyMethod
pathtextread onlyPath
tool_nametextread onlyTool name
module_keytextread onlyModule key
resource_keytextread onlyResource key
statusintegerread onlyStatus
outcometextread onlyOutcome
refusaltextread onlyRefusal
row_countintegerread onlyRow count
duration_msintegerread onlyDuration ms
remote_iptextread onlyRemote ip
origintextread onlyOrigin
user_agenttextread onlyUser agent
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

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 › API Call Log 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.