GetPrepared

[POST] .../v1/reportbuilder/getprepared

Returns prepared report builder results and their metadata. Use this method to retrieve prepared results created by ReportBuilder/AddRequest. Use filters to select a prepared builder result by request_uuid or user_id. If include_data=true, the data field contains the prepared report file bytes encoded as Base64. The report file is GZIP-compressed (.gz): decode Base64 first, then decompress GZIP to obtain the report payload. If include_data is false or omitted, data may be null and file_url contains the URL of the prepared GZIP (.gz) report file. The decompressed payload format depends on the report type; JSON reports should be parsed as UTF-8 JSON. The caller must have prepared-report read permission 350, report-builder permission 759 and an account tariff with report builder enabled; missing body, denied access, unavailable tariff, invalid filters, unavailable CDN file, translation lookup errors or database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name	Type	Required	Description
filters	Array of Filter	Optional	Optional filters by fields available for this API method.
include_data	Boolean	Optional	When true, embeds the prepared.gz report file in data as Base64-encoded bytes. When false or omitted, only report metadata and file_url are returned.

Filterable Fields

Field	Type	Description
request_uuid	string
user_id	int

Request Example

{
  "filters": [
    {
      "Field": "request_uuid",
      "Operator": "Equal",
      "Value": "f20c8f37-8bcb-4f7c-8dc5-8b0b2f4f0c11"
    },
    {
      "Field": "user_id",
      "Operator": "Equal",
      "Value": "5"
    }
  ],
  "include_data": false
}

Response Parameters

Name	Type	Description
ok	Boolean	Indicates whether the request completed successfully.
result	Array of ReportPrepared	Result object.

Response Example

{
  "ok": true,
  "result": [
    {
      "user": {
        "id": 5,
        "name": "Manager"
      },
      "request_uuid": "f20c8f37-8bcb-4f7c-8dc5-8b0b2f4f0c11",
      "file_url": "https://cdn.example.test/token/report_f20c8f37.json.gz",
      "description": null,
      "warnings": null,
      "parameters": "{\u0022domain\u0022:\u0022Nomenclature\u0022,\u0022filters\u0022:{\u0022firm_id\u0022:2}}",
      "report": {
        "id": 33,
        "name": "Report builder"
      },
      "data": null,
      "saved": false,
      "date": 1772527200
    }
  ]
}