POST
/
v1
/
reports
Create a Report
curl --request POST \
  --url https://smart-templates.sandbox.midaz.io/v1/reports \
  --header 'Content-Type: application/json' \
  --data '{
  "templateId": "01953d09-e6cb-7c1c-a01a-272855a9ffb7",
  "filters": {
    "midaz_onboarding": {
      "account": {
        "created_at": {
          "between": [
            "2025-08-02",
            "2025-08-03"
          ]
        }
      }
    }
  }
}'
{
  "id": "0196c5c0-5044-724f-95f3-4b32076e7ad7",
  "templateId": "01953d09-e6cb-7c1c-a01a-272855a9ffb7",
  "filters": {
    "midaz_onboarding": {
      "account": {
        "created_at": {
          "between": [
            "2025-08-02",
            "2025-08-03"
          ]
        }
      }
    }
  },
  "completedAt": null,
  "createdAt": "2025-05-12T18:27:17.188156815Z",
  "updatedAt": "2025-05-12T18:27:17.188156815Z",
  "deletedAt": null
}

Headers

​
Authorization
string

The authorization token. Important: This header is required if your environment has the Acces Manager plugin enabled.

​
X-Organization-id
string

The unique identifier of the Organization associated with the request.

Body

application/json

Details of the request to generate the report.

​
templateId
string
required

Unique identifier of the template used to generate the report.

​
filters
object

Object that defines the filtering criteria applied to the data used in the report. Now supports advanced filtering operators including equality, comparison, range, and list-based conditions.

Response

Indicates that the resource was successfully created and the operation was completed as expected.

Details about the report that was created.

​
id
string

Unique identifier of the report generation request.

​
templateId
string

Unique identifier of the template used to generate the report.

​
filters
object

Object that defines the filtering criteria applied to the data used in the report. Now supports advanced filtering operators including equality, comparison, range, and list-based conditions.

​
status
string

Current status of the report

​
completedAt
string

Timestamp marking when the report processing was completed.

​
createdAt
string

Timestamp marking when this report request was created.

​
updatedAt
string

Timestamp marking the last update to this report request.

​
deletedAt
string

Timestamp marking when this report request was soft deleted, if applicable.