Can't figure out how to create a report run with parameters through API

I have a report that has a parameter for client_id. I can create a new run with parameters from the web client, but I can't seem to find anywhere in the documentation that describes how to specify report parameters through the api.

Web form works fine when I fill out the form here:

https://modeanalytics.com/<my_account>/reports/<my_report>/

API endpoint used:

POST -> https://modeanalytics.com/api/<my_account>/reports/<my_report>/runs/

I have tried raw data of `{"parameters": {"client_id":"123"}}`, `{"client_id":"123"}`, `{"params":{"client_id":"123"}}`, etc. but when I query report runs, the parameter always has a value of null, and the ones created with the web form always have the value I entered.

1reply Oldest first
  • Oldest first
  • Newest first
  • Active threads
  • Popular
  • Hi Grant Lester - apologies for the delayed response.

    When accessing a Mode report via URL, you can provide values for the report's parameters within the URL itself by adding them to the URL as follows:

    https://modeanalytics.com/{{org_username}}/reports/{{report_token}}?param_client_id=123

    Basically, prepend the parameter name that you've defined in your Liquid code with "param_".

    More information can be found in our documentation:

    https://help.modeanalytics.com/articles/parameters/#control-parameter-values-via-report-url

    Hope that helps - please do reach out to our success team via in-product chat or success@modeanalytics.com if we can be of further assistance. Thanks!

    Reply Like
Like Follow
  • Status Answered
  • 4 mths agoLast active
  • 1Replies
  • 488Views
  • 2 Following

Create A New Discussion

Share your thoughts