Run in Apidog
This API operation enables merchants to generate customized reports by specifying report types and associated parameters. It allows for the selection of key data points, such as date ranges, transaction types, and other relevant filters, ensuring precise and meaningful insights. By defining these parameters, merchants can tailor reports to meet their financial tracking and analytical needs, enhancing decision-making and operational efficiency. Request Body# Field Name Type Required Description name string Yes The name of the report being generated. reportTypeId integer Yes The unique identifier of the report type. parameters array Yes A list of parameters needed for generating the report. parameterId integer Yes The unique identifier of a specific parameter. value string Yes The value associated with the parameter.
Response Body# Field Name Type Description id integer The unique identifier of the generated report. name string The name of the generated report. reportTypeId integer The unique identifier of the report type. parameters array A list of parameters used in the generated report. parameterId integer The unique identifier of a specific parameter. value string The value associated with the parameter.
Request Body Params application/json
{
"name" : "Test Report 2" ,
"reportTypeId" : 1 ,
"parameters" : [
{
"parameterId" : 1 ,
"value" : "2024-01-01"
} ,
{
"parameterId" : 2 ,
"value" : "2024-07-08"
} ,
{
"parameterId" : 3 ,
"value" : "OUTWARD"
} ,
{
"parameterId" : 4 ,
"value" : "ALL"
}
]
} Request samples curl --location --request POST '/admin/reporting' \
--header 'Content-Type: application/json' \
--data-raw '{
"name":"Test Report 2",
"reportTypeId":1,
"parameters":[
{
"parameterId":1,
"value":"2024-01-01"
},
{
"parameterId":2,
"value":"2024-07-08"
},
{
"parameterId":3,
"value":"OUTWARD"
},
{
"parameterId":4,
"value":"ALL"
}
]
}' Responses application/json Generate Code
{
"id" : 1 ,
"name" : "Test Report" ,
"reportTypeId" : 1 ,
"parameters" : [
{
"parameterId" : 1 ,
"value" : "2024-01-01"
} ,
{
"parameterId" : 2 ,
"value" : "2024-07-08"
} ,
{
"parameterId" : 3 ,
"value" : "ALL"
} ,
{
"parameterId" : 4 ,
"value" : "ALL"
} ,
{
"parameterId" : 5 ,
"value" : "26"
}
]
}
Modified at 2025-03-02 15:36:10
