POST /api/BiReports/GetReportByName
Looks up the Metabase report by its exact name (case-insensitive), applies SQL template-tag parameters, then returns the file.
Each parameter must match a {{variable_name}} defined in the Metabase SQL question.
Supported types: date/single, category, number/=.
Dates must be formatted as yyyy-MM-dd.
Example body:
[
{ "name": "start_date", "value": "2024-01-01", "type": "date/single" },
{ "name": "end_date", "value": "2024-12-31", "type": "date/single" }
]
curl -X POST "/api/BiReports/GetReportByName" \
-H "Authorization: $ATLAS_ETRM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/json" \
-d '[
{
"name": "string",
"value": "string",
"type": "string"
}
]'Authorization
AuthorizationstringheaderrequiredJWT Authorization header using the Bearer scheme. Enter your token including the 'Bearer ' prefix (e.g. 'Bearer eyJ...').
Parameters
namestringqueryThe exact name of the Metabase question/card.
formatstringqueryThe export format (csv, json, or xlsx). Defaults to xlsx.
Default:xlsx
Body
List of template-tag parameters to inject into the Metabase query.
namestring | nullThe template-tag variable name as defined in the Metabase SQL query (e.g. "start_date").
valuestring | nullThe value to inject into the variable. Dates must be formatted as yyyy-MM-dd (e.g. "2024-01-01").
typestring | nullMetabase parameter type. Common values: "date/single" — basic Date variable, "category" — basic Text variable, "number/=" — basic Number variable.
Response
The report file in the requested format.
"string"