Get report parameters
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
GET https://api.rollstack.com/public/v1/reports/{id}/parameters
A report's parameters, with which ones a burst can vary by, the dashboard filters and the datasheet columns a parameter can link, with the parameter that already links each.
Requires the slide_decks:read scope.
Operation ID: getReportParameters.
Path parameters
id(string, required): The report to act on, by itsidfromlistReportsorcreateReport. Only reports whosetypeisSlideDeckwork here: another type, such as a Google Slides presentation, returns400. You can also copy it from the report's link in Rollstack: it's the part right after/slides/.
Response 200
Success
application/json
parameters(array of object, required): The report's parameters, oldest first. Empty until one is created, here or in the app.id(string, required): The report parameter's id. Pass it inparameterIdstocreateBurstwhenburstableistrue.name(string, required): The report parameter's name, as shown in Rollstack.value(object or null, required): The parameter's value, which the report's datasheets read through the filters it links.nullwhen it has none, and those filters keep their own values. A value of a report parameter, in the shape of its type. Copy the shape of the parameter'svalueinlistBursts, or of a variant's inlistBurstVariants:- A list of values:
{ "type": "categorical", "values": ["EMEA"] }, with at least one value.operatorcan also beis_not,containsordoesnt_contain; it isiswhen left out. - A number:
{ "type": "number", "value": 10 }. Text:{ "type": "text", "value": "EMEA" }. - A date range:
{ "type": "date", "subtype": "date_range", "startDate": "2026-01-01", "endDate": "2026-03-31" }. One date:{ "type": "date", "subtype": "date_single", "date": "2026-03-31" }. - A month or a quarter:
{ "type": "date", "subtype": "date_month_year", "month": 3, "year": 2026 }(months 1 to 12),{ "type": "date", "subtype": "date_quarter_year", "quarter": 1, "year": 2026 }. - A relative period:
{ "type": "date", "subtype": "date_relative", "rangeType": "lastN", "rangeN": 3, "periodType": "months" }.rangeTypeiscurrent,lastNornextN;periodTypeisdays,weeks,months,quartersoryears, orcompleteDaysthroughcompleteYearsfor whole periods only. - When
typeiscategoricaltype(categorical, required)values(array of string or number, required)operator(string): One ofis,is_not,contains,doesnt_contain.
- When
typeisdateandsubtypeisdate_rangetype(date, required)subtype(date_range, required)startDate(string, required)endDate(string, required)
- When
typeisdateandsubtypeisdate_relativetype(date, required)subtype(date_relative, required)rangeType(string, required): One ofcurrent,lastN,nextN.rangeN(number, required)periodType(string, required): One ofdays,weeks,months,quarters,years,completeDays,completeWeeks,completeMonths,completeQuarters,completeYears.
- When
typeisdateandsubtypeisdate_month_yeartype(date, required)subtype(date_month_year, required)month(number, required)year(number, required)
- When
typeisdateandsubtypeisdate_quarter_yeartype(date, required)subtype(date_quarter_year, required)quarter(number, required)year(number, required)
- When
typeisdateandsubtypeisdate_singletype(date, required)subtype(date_single, required)date(string, required)
- When
typeisdateandsubtypeisdate_nulltype(date, required)subtype(date_null, required)
- When
typeisnumbertype(number, required)value(number, required)
- When
typeistexttype(text, required)value(string, required)
- A list of values:
columns(array of object, required): The columns of datasheets the parameter links: its value is written into each as a row filter, in that datasheet only. Empty when it links none.datasheetId(string, required): The datasheet's id, as inlistReportDatasheets.datasheetName(string or null, required): The datasheet's name, ornullif it has none.column(string, required): The column's name in the datasheet's source.kind(string, required): The kind of value that filters the column, and so thetypeof a parameter value that reaches it:categoricaltakes a list,numbera number anddatea date. One ofcategorical,number,date.isLinked(boolean, required):falseonce the column was unlinked in Rollstack: the parameter no longer writes into it.
burstable(boolean, required): Whether a burst can vary by the parameter: it links at least one filter whosevalueTypeisn'tnull, or at least one column that is still linked. A parameter that links neither can't be.
filters(array of object, required): The filters a parameter can link: those of the dashboards the report's datasheets read. Empty when the report reads no dashboard, such as one built only from uploaded files and spreadsheet ranges, which can't have parameters.id(string, required): The filter's id. Pass it infilterIdstocreateReportParameter.name(string, required): The filter's name on its dashboard.connectionType(string, required): The kind of connection the dashboard is on, such asLooker. One ofGoogleSheet,GoogleExcel,MicrosoftExcel,Tableau,Salesforce,Metabase,PowerBI,Looker,RollstackVariable,Lightdash,Omni,Sigma,Snowflake,Databricks,BigQuery,CsvUpload,XlsxUpload,ManualTable,Dbt.dashboardName(string, required): The dashboard the filter is on, as its connection names it.datasheets(array of object, required): The report's datasheets that read the filter's dashboard, which a parameter linking it writes its value into.id(string, required): The datasheet's id, as inlistReportDatasheets.name(string, required): The datasheet's name.
parameterId(string or null, required): The parameter that links the filter, by itsidinparameters. A filter follows one parameter at most, so a new parameter can only link filters where this isnull.valueType(string or null, required): The kind of value Rollstack can set in the filter, and so thetypeof a parameter value that reaches it.nullwhen only the dashboard's own embed can edit the filter: a parameter can link it, but can't set its value or be burst by it. One ofcategorical,date,number,text.
columns(array of object, required): The columns a parameter can link: those of the datasheets the report has already read, from a source Rollstack can filter by rows, with a kind of value that can filter them. A datasheet never read, or read before Rollstack kept its columns' types, has none: seedatasheetsToRefresh.datasheetId(string, required): The datasheet's id, as inlistReportDatasheets. Pass it incolumnstocreateReportParameter.datasheetName(string, required): The datasheet's name.column(string, required): The column's name in the datasheet's source.kind(string, required): The kind of value that filters the column:categoricaltakes a list,numbera number anddatea date. One ofcategorical,number,date.parameterId(string or null, required): The parameter that links the column, by itsidinparameters. A column follows one parameter at most, so a new parameter can only link columns where this isnull.
datasheetsToRefresh(array of object, required): The datasheets whose columns can be linked once the report is run again, as a run reads them.id(string, required)name(string, required)