Platform · Report Data Sources
Report Data Sources
Models of this company's own for the Report Studio, over an allow-list of business records and the company's own custom objects. Dimensions and key figures come from the records' fields. People see them under the grants they already hold on the records, within their business unit and location; columns hidden from a role, personal by name or flagged sensitive are never offered.
/api/platform/report-sourcesPublished as /api/v1/report-sourcesDownload specification (OpenAPI 3.1) Screen: Report Data Sources
Overview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › Report Data Sources 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. |
| Table | rpt.tenant_cubes · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/report-sourcesList report data sources
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cube_key": "text",
"label": "text",
"description": "text",
"entity": "text",
"include_columns": [],
"is_active": true,
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"created_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/report-sources?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/report-sources/{id}Read one report data source
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cube_key": "text",
"label": "text",
"description": "text",
"entity": "text",
"include_columns": [],
"is_active": true,
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"created_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/report-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/report-sources/choices/{kind}Choices
Path parameters
| Name | Type | Description |
|---|---|---|
kind | string (uuid) | The record's kind, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/report-sources/choices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/report-sourcesPost report data sources
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/report-sources" \
-H "Authorization: Bearer $TOKEN"PUT/api/platform/report-sources/{id}Put report data sources
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/report-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/platform/report-sources/{id}Delete report data sources
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/report-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/report-sources/{id}/previewPreview
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/report-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/report-sources/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/report-sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a report data source, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
cube_key | text | read only | Key — Lower case letters, digits and underscores. The model is t_<key>; saved layouts are filed under it, so it cannot change. |
label | text | read only | Name — How the model is named in the Report Studio. |
description | text | read only | What it covers — Shown on the model's card. |
entity | text | read only | Built over — Company business records, or one of this company's custom objects. |
include_columns | _text | read only | Only these columns — Comma-separated column names. Empty offers every column that may be offered. |
is_active | boolean | read only | On — Off withdraws the model from the catalogue; saved layouts are kept. |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
updated_by | uuid | read only | Updated by |
updated_at | timestamp with time zone | read only | Updated at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Report Data Sources for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.