Service Titan Knowledge Base

Create and edit KPI modules for custom dashboardsLast updated on 03/22/2022

Use KPI modules to view up to six key performance indicators (KPIs) from a report template on custom dashboards. This lets you keep valuable business metrics on your dashboard, updated in real time.

Things to know

  • To create or edit a dashboard module, make sure you have the correct dashboard permissions enabled. Contact your account administrator for help.

Create a KPI module

  1. While creating or editing a custom dashboard, click Add Module. Add Module opens.

  2. Under Module Type, click the dropdown and select KPI.

  3. Click the Template dropdown and select the report template you want to build your module on. Tip: Use the search bar to find a specific template by name.

  4. Under Select existing KPIs, select the KPIs to include in the module. You can select up to six.

  5. Click Next.

    KPI Module Settings opens.

  6. Edit the module settings as needed:

    • Enter a name for your module in the Module Name field.

    • Select Hide module title row to hide the module name and filters from view on the dashboard.

    • Under Selected KPIs, drag and drop KPIs to change their order.

    • To change how you want to calculate the KPI in the module, next to Aggregation method, click Expand icon-carat-inverted.png and make a selection:

      • Count—Total number of entries

      • CountDistinct—Total number of unique entries

      • Sum—Sum of values

      • Average—Sum of values divided by the number of entries

      • Minimum—Smallest numerical value

      • Maximum—Largest numerical value

      Note: Available options depend on the KPI. For example, Sum and Average are not available for date-based KPIs.

  7. When you’re finished, click Add. The module layout displays in the dashboard editor.

  8. If all looks good, click Save or, if you want to make further changes, you can edit the KPI module.

Edit a KPI module

  1. Go to the navigation bar and click Dashboard.

  2. Click the Modular Dashboard dropdown and select the dashboard with the module you want to edit.

    The dashboard opens.

  3. Click Edit Dashboard.

  4. Edit the KPI module as needed:

    • To edit the module name and KPIs, clickSettings icon-settings.png in the module header.

    • To edit the default report filters, click Filter icon-filter.png.Note: Some date range and business unit filters are set by the dashboard’s custom filters and cannot be edited unless you exclude them from the custom filter.Tip: For details on how filters are applied to a report template, see the corresponding report template guide.

    • To delete the module, click Delete icon-trash.png.

  5. When you’re finished editing the module, click Save.

Want to learn more?

Important note: Some features may not be currently included in your account and additional configuration may be required. Please contact technical support for details.

Disclaimer: Information provided in this article is for informational purposes only and it should not be construed to be legal advice. Information provided in this article may also not constitute the most up-to-date legal or other information. You should not act or refrain from acting on the basis of any information in this article to meet any compliance requirements without seeking independent legal or other professional advice.