IFRCGo / go-frontend

MIT License
21 stars 5 forks source link

Reporting Hub with API Query Generator #1804

Open JonathanGarro opened 3 years ago

JonathanGarro commented 3 years ago

Is your feature request related to a problem? Please describe. We've had very initial conversations about this, but logging here per a recommendation from Gulfaraz as a way to collect ongoing feedback and thoughts from folks I've spoken to.

As we continue to document common workflows for extracting data from the GO platform, something that Simon Johnson has done with a HXL dashboard underscores the opportunities we have to simplify the process and lower the technical barriers to entry related to how lesser-resourced National Societies can make use of the data.

While documentation for users with a relatively higher degree of technical capacity for API calls and visualization will remain important, we may consider building out a front-end element that mimics the functionality that Simon has built. By using menus with drop-downs to create customized parameters, users can either us GO to create reports that answer specific questions they may have directly on the site (e.g. how many emergency appeals have been released between 2015 and 2020 related to tropical cyclone events in the Americas Region) or generate the REST URL necessary to answer that question in their own BI tool like PowerBI, Tableau, etc.

Describe the solution you'd like There are two potential outcomes: the simple URL generator, or the more complete "reporting hub"

URL Generator A series of drop-down menus that allow users to select the parameters they want out of the API. After selecting the elements and search parameters, the system would provide the relevant call that they could copy/paste into another program or dashboarding tool. Right now a barrier for some API usage is the non-user-friendly classification of some field types - for example, the regions, EA statuses, disaster types, etc., use codes rather than plain-text names).

Reporting Hub A more feature-rich option would take a similar approach as above, but provide a more complete experience by also housing (basic) data visualization tools based on those reporting functions outlined above, as well as the ability to output the results to a PDF (see Simon's example that builds on existing IFRC.org functionality in the cadenza document).

Describe alternatives you've considered This would be a new feature, and the two options outlined provide for a simpler and a more complex implementation.

Where does the data come from and how is it maintained? Existing GO data.

Should there be any restrictions around viewing or updating information related to this feature This should require RCRC user credentials.

Links to documentation To be discussed.

nanometrenat commented 7 months ago

GO Workplan 2024 has more details on this work item (page 8-9)