search

apinf / platform

Apinf - Open source API management platform with multi proxy and protocol support
https://apinf.com/
European Union Public License 1.1
74 stars 33 forks source link

Dashboard UX testing #3418

Closed 55 closed 6 years ago

55 commented 6 years ago

Test our dashboard pages and make a list of possible bugs, improvements.

Nazarah commented 6 years ago

Environment: https://nightly.apinf.io OS: Windows 10 Browsers: Chrome (Latest), Microsoft Edge 41.16299.248.0

Nazarah commented 6 years ago

Known Issues:

  1. Charts in "Last 24 hours" timeline should have x-axis divide into hours instead of showing a single unit.
  2. (last 24 hours & last 7 days), API request overview shows fraction of one single requests in Y-axis (e.g. 0.2,0.4,0.6,0.8,1.0). One single request shouldn't be broken down into fraction as request is a whole number.
Nazarah commented 6 years ago

Improvement Suggestions:

  1. Using line charts instead of bars to show changes in trends in KPIs for overview charts.

  2. When going into analytics view  from Dashboard, browser tab shows it with name "Blank Page". This should be named as something: "Analytics - "

  3. When an API is connected to a proxy and calls are made to it, the API appears in dashboard view after 30 minutes. This is a big UX problem and can act as an obstacle during demonstration. Optimize this time s.t. APIs appear in DB within no more than 5 minutes.

  4. When a new API is newly added, no comparison values should appear for any KPIs for any selected time period.

  5. Should we consider keeping KPI comparison for only last 24 hours? This would make calculation easier. Beside we  need a bit more research to think about how to show KPI comparison for last 7 days and last 28 days.

  6. More details about unique user is needed. Unique user is counted if users use API keys. But this information is missing

  7. For a newly added API, should we consider showing last 7 days and last 28 days options only if the API is that much older? (Alt: Date picker?)

  8. Do we need to consider comparison rate that is above 100%?

  9. Keeping a separate controller, UI to make comparison? The comparison could be made within a customized time inter val (starting point: Connecting an API to proxy and calling it, End point: current date) This might make the calculation easier.  Comparison can show different metrics as numbers. Also API calls and type of responses can be shown as achart.  The time selection should be date basis

  10. http://recordit.co/3BGhmw35E7 In the API request timeline, is it needed to show API response plot (for 2xx, 3xx, 4xx and 5xx) if the number of respond for a specific category is 0? the above video was taken for Last 7 days time period.

  11. if request number exceeds six figures, we can show shortened versions of the number of request in both Dashboard and Analytics view. For example, if no. of request is 1050000 or 1056722, we can show it as image. Here, API owner might not need to know the exact number but the fact that numbe rof request have exceeded 1050000.

  12. API owners should be made aware that only requests that are made to the API via the configured proxy base path in API profile will appear in the Dashboard.

Nazarah commented 6 years ago

Improvement Suggestions:

  1. Should we consider showing all APIs in a single ist instead of diving them to my APIs, APIs I manage and Other APIs (admin role)? If we have a filtering option that can show APIs in the dashboard if I filter it with an organization name (e.g. considering API is added in the dashboard.) then we don't need to keeps separators like above. This is also better in the sense, large numbers APIs under one category (e.g.) will not hold up the most place in the page.

  2. Can we also somehow incorporate showing APIs per proxy within filtering option? I got confused when I returned to the Dashboard after making some calls and the the API was not appearing in the list. (The PAI was connected to a proxy via API profile). I had to manually select a proxy to make the added API appear in the list.

  3. Should we consider json formats for error report download? (e.g. refer to postman script runner)

  4. Usability Issue On clicking See details for an API in Dashboard view, the selected proxy (in the dropdown menu) changes into the very 1st one in the list. For this reason, shown statistics in the dashboard disappears. [condition: before clicking more details, the proxy needs to be set into any one other than the 1st one in the dropdown

  5. Details View: Should we consider automatically changing API paths in all charts when the path is changed in one chart?

  6. Hiding excess elements in Dashboard/Details view: Usually when an API doesn't have any key requirement, the Unique users chart doesn't have any plots charted in it. So we can hide this chart and inform users about it with appropriate help text.

  7. Keeping comparison funtion in both view.