---
schema_version: "1"
id: bf81fef0ce09b7140fc53839bf643a882e62670661ff1e2ccaf07d9bc036cffd
title: Report on Quip Usage with Salesforce Reports
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/quip_template_metrics_setup.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.quip_template_metrics_setup.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 38b8e7ba7a2691f148a3935f30da33dec767f7ca4ffd8f9979663be39a60dc82
description: Get metrics on how your users engage with templates and documents embedded in Salesforce. Create custom Quip reports and add them to your Lightning dashboards.
products:
  - Quip
  - Cross Cloud
release: "264"
---
# Report on Quip Usage with Salesforce Reports

Get metrics on how your users engage with templates and documents embedded in Salesforce. Create custom Quip reports and add them to your Lightning dashboards.

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition"><colgroup><col></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: Lightning Experience</td></tr></tbody></table>

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small permission">
        <colgroup>
          <col style="width:50%">
          <col style="width:50%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="colgroup" class="slds-cell-wrap" colspan="2" style="text-align:center;vertical-align:top;" id="d34708e52">User Permissions Needed</th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d34708e52 ">To create and update custom report types:</td>

            <td class="slds-cell-wrap" style="vertical-align:top;" headers="d34708e52 ">
              <dl>

                <dt style="font-weight:bold;padding-top:.25rem;">Legacy Folder Sharing</dt>

                <dd style="padding-left:1.5rem;padding-bottom:.5rem;">Create and Customize Reports<p>AND</p>
                  <p style="margin-bottom:0;">Manage Custom Report Types</p>
                </dd>


                <dt style="font-weight:bold;padding-top:.25rem;">Enhanced Folder Sharing</dt>

                <dd style="padding-left:1.5rem;padding-bottom:.5rem;">Create and Customize Reports<p>AND</p>
                  <p style="margin-bottom:0;">Manage Custom Report Types</p>
                </dd>

              </dl>
            </td>

          </tr>
          <tr class="">
            <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d34708e52 ">To build a dashboard:</td>

            <td class="slds-cell-wrap" style="vertical-align:top;" headers="d34708e52 ">
              <dl>

                <dt style="font-weight:bold;padding-top:.25rem;">Legacy Folder Sharing</dt>

                <dd style="padding-left:1.5rem;padding-bottom:.5rem;">Drag-and-Drop Dashboard Builder</dd>


                <dt style="font-weight:bold;padding-top:.25rem;">Enhanced Folder Sharing</dt>

                <dd style="padding-left:1.5rem;padding-bottom:.5rem;">Drag-and-Drop Dashboard Builder</dd>

              </dl>
            </td>

          </tr>
        </tbody>
      </table>

Quip engagement metrics apply to templates and documents added to Quip Lightning components. Quip engagement metrics are turned on by default in all orgs with Quip enabled, except for Salesforce sandboxes. It takes 24 hours for metrics data to refresh.

1. Enable the Quip Metrics permission set.
    1. In Setup, enter Permission Sets in the Quick Find box.
    2. Select the permission set you want to assign Quip engagement metrics to, or assign it to a new one. Users assigned the Quip Metrics permission set can see all linked document titles, regardless of their individual access to them.
    3. Under System, click **System Permissions** and then **Edit**.
    4. Enable Quip Metrics.
    5. Save the action.
2. To add metrics for templates and documents to a Lightning report, create a custom report type.
    1. In Setup, enter Report Types in the Quick Find box.
    2. Click **New Custom Report Type**.
    3. Select a Quip Primary Object for your custom report type.
        
        ![quip primary objects highlighted](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-anywhere_app-264-0-0-production-enus/c0406050-7b26-469a-9dc5-10d6c0c9c576/anywhere_app/images/quip_new_report_type.png)
        
        ![Tip](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-anywhere_app-264-0-0-production-enus/c0406050-7b26-469a-9dc5-10d6c0c9c576/images/icon_tip.png)
        
        Tip Quip objects begin with Collaboration. [See Quip Engagement Objects.](https://help.salesforce.com/s/articleView?id=xcloud.quip_template_metrics.htm&release=264.0.0&type=5 "Use Quip engagement metrics in Lightning reports to measure which users are interacting with documents associated with Salesforce records, and how those users are interacting with them.")
    4. Enter the Report Type Label and the Report Type Name.
        
        The label can be up to 50 characters long. If you enter a name that is longer than 50 characters, the name gets truncated. SOAP API uses the name.
    5. Enter a description for your custom report type of up to 255 characters. If you enter a name that is longer than 255 characters, the name gets truncated.
    6. Select the category where you want to store the custom report type.
    7. Select a Deployment Status. Click **Next** and then save your changes. Quip metric objects don’t have any child objects.
    8. To use Collaboration Document Metrics Records or Collaboration Template Metrics Records to get metrics on specific document fields like document titles, add fields via lookup.
    9. Click **Edit Layout**.
        
        ![Quip Doc Metrics edit field layout](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-anywhere_app-264-0-0-production-enus/c0406050-7b26-469a-9dc5-10d6c0c9c576/anywhere_app/images/quip_doc_metrics_type.png)
    10. Under View: Collaboration Document Metric Record Fields, click **Add fields related via lookup**.
    11. Select **Collaboration Document Metric**, and choose the fields you want to add. Click **OK**.
    12. Save the action.
3. Create a report using your new custom report type.
    
    1. In Salesforce, go the Reports tab and click **New Report**.
    2. Select your new custom report type and click **Continue**.
        
        ![Choose Report Type: Quip Doc Metrics](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-anywhere_app-264-0-0-production-enus/c0406050-7b26-469a-9dc5-10d6c0c9c576/anywhere_app/images/quip_new_report_metrics.png)
    3. Set the Last Updated Date to **All Time** and click **Run**.
    
    ![Quip Document metrics report](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-anywhere_app-264-0-0-production-enus/c0406050-7b26-469a-9dc5-10d6c0c9c576/anywhere_app/images/quip_template_metrics_report.png)
4. Add your report to an existing or new Lightning dashboard.