This guide assumes you are familiar with Dashboards already. If not, please review API Dashboards
Moesif does not have any limits on the number of dashboards you can create nor any limits on the number of workspaces (charts) a dashboard can contain.
A Workspace is a single Chart or “Card” on a dashboard and represents a specific metric. A Dashboard is a collection of workspaces and can also hold other dashboards like a file directory.
Creating a dashboard
If you don’t have a dashboard already, you can create a new dashboard via the left directory structure. Rolling over an existing dashboard will place the new dashboard under it, or you can select the top + button to add a new dashboard at the top level.
Saving a workspace to a dashboard
You can save almost every chart you see in Moesif to a dashboard whether it’s a time series, bar chart, heatmap, table, or funnel. To get started, navigate to Events, Users, or Companies to start a new analysis. Within the chart view, set up the filters, group by, and time range as you would like for your chart.
For example, to add a time series chart to your dashboard showing API usage broken down by company domain, then go to Events -> Time Series and adjust your chart to group by company domain.
If the date range is relative such as Last 7 Days, then the chart will always be up to date for latest data. However, if you select an absolute time range like May 1, 2020 to May 31, 2020, then the chart data will not be refreshed (unless the date range is in the future).
When you’re done setting up your metric, click the orange Save button on the top right.
Types of workspaces
When you click Save, you’ll be presented with four sharing types: Private, Team, Public Link, and Embed Template.
Private workspaces can only be viewed by yourself. Other members of your Moesif organization will not see that chart even if they have access to the dashboard that you added the chart to. It’s effectively hidden from discovery.
Team workspaces are discoverable by anyone that has access to your Moesif organization, which can be seen under Apps and Team settings menu. With team level sharing, it’s easy to collaborate on KPIs and reports and share with other internal stakeholders.
Anyone with the public link can access the chart. Unlike Private or Team sharing, a person can view a public workspace even if they haven’t signed up for Moesif. These are also saved to a Dashboard, but most customers leverage public links to share a single chart with a customer or partner.
Public links can also be used to embed the chart directly via iFrame. You will be given both options after clicking save.
Restricting data access
Because public links are intended to be shared with external parties, the data will be sandboxed by your chosen filters. For example, if you filter by a specific user id, then anyone with the public link can only access API data made by that specific user id. Keep in mind not all filters support data sandboxing, but Moesif will show you which filters will be used before saving the link.
Embed templates are a special type of sharing that enables you to build powerful charts and embed in customer-facing portals. Dynamic fields don’t need to be set until the chart is actually rendered.
Unlike public links which are static, Embed templates enable the filter criteria to be dynamic and set by your backend. For example, you may want to dynamically set the user id to the customer who logged into your web app.