Uploaded image for project: 'Camunda Optimize'
  1. Camunda Optimize
  2. OPT-3403

Support raw data download via API for external analysis and display

    XMLWordPrintable

Details

    Description

      What is the desired functionality that you are missing?

      Currently, it is possible to download CSV files via the UI or using an internal API. But that hast the following issues:

      • download via UI: if I want to perform calculations based on the data that's coming from the CSV export, a lot of manually work is involved.
      • internal API: technically it is possible to download a CSV file using the internal API (e.g. REST), but it is not officially documented and supported (e.g. Camunda could just change the Endpoint whenever they want).

      As a user, I would like to use the REST API to download a JSON file of a defined report.
      For raw data reports, I want to be able to paginate across many rows (1-1000, 1001-2000, 2001-3000, etc)

      Which problem are you going to solve with this functionality?

      On a regular basis (monthly) we need to create reports (for cost calculation). Optimize data (specific reports) are a basis for this calculation. We would like to automate this calculation so we do not have to manually download the CSV file, open it with Excel, and do the calculation there. Instead, we want to get the data from Optimize that we configured, then do the calculation and send out the results automatically. Therefore Optimize should have a download data API.

      Use Case: I want to analyze my variables offline because I can't create the right graphs in Optimize (variable vs variable)

      Use Case: I want to visualize my data in a different application because my organization uses a different analytics tool

      Use Case: I want to programmatically download a report to bill my internal customers appropriately (SUPPORT-7189)

      mgm-controller-panel

        This is the controller panel for Smart Panels app

        Attachments

          1. example.png
            example.png
            84 kB
          2. example-2.png
            example-2.png
            177 kB

          Issue Links

            depends on

            Bug Report - A problem which impairs or prevents the functions of the product. OPT-5789 Endpoint path missing a / and inconsistent variable naming

            • L3 - Default - Minor issue or issue with existing workaround, feature requests and questions
            • Done
            is depended on by

            Sub-task - The sub-task of the issue OPT-5784 Document the public API for exporting paginated JSON Data in the Optimize docs

            • L3 - Default - Minor issue or issue with existing workaround, feature requests and questions
            • Done

            Feature Request - A new feature of the product, which has yet to be developed. OPT-3404 Allow passing in filter parameters to CSV download API

            • L3 - Default - Minor issue or issue with existing workaround, feature requests and questions
            • Open
            is related to

            Bug Report - A problem which impairs or prevents the functions of the product. OPT-5789 Endpoint path missing a / and inconsistent variable naming

            • L3 - Default - Minor issue or issue with existing workaround, feature requests and questions
            • Done

            Feature Request - A new feature of the product, which has yet to be developed. OPT-5640 Safely export larger raw data reports than the CSV limit

            • L3 - Default - Minor issue or issue with existing workaround, feature requests and questions
            • Open

            Feature Request - A new feature of the product, which has yet to be developed. OPT-5768 Support report data download via API for all report types for external analysis and display

            • L3 - Default - Minor issue or issue with existing workaround, feature requests and questions
            • Done
            links to

            Web Link https://github.com/camunda/issues/issues/492

            Web Link https://github.com/camunda/issues/issues/541

            Activity

              People

                Unassigned Unassigned
                felix.mueller Felix Mueller
                Giuliano Rodrigues Lima Giuliano Rodrigues Lima
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Salesforce