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.
Required Editions
| Available in: Lightning Experience |
Quip objects begin with Collaboration. Quip metric objects don’t have secondary objects.
Collaboration Document Metrics
The Collaboration Document Metrics object captures the metrics for a Quip document.
| Field Name | Description |
|---|---|
| Commenter Count | The number of unique users who commented on the document on a given day |
| Document | The Quip document ID |
| Document Title | The Quip document title |
| Document URL | The Quip document URL |
| Editor Count | The number of unique users who edited the document on a given day |
| Last Updated Date | The date that the document was created, last edited, or last shared (shown in your local time zone in Salesforce reports) |
| Last Updated Date Only | The date that the document was created, last edited, or last shared in UTC |
| Metric Date | The date that the metric was gathered (shown in your local time zone in Salesforce reports) |
| Metric Date Only | The date that the metric was gathered in UTC |
| Site | The Quip site ID |
| Source Template | The source template ID |
| Source Template URL | The source template URL |
| Update Count | The number of edits made on the document on a given day |
| Viewer Count | The number of unique users who viewed the document on a given day |
Collaboration Document Metric Records
The Collaboration Document Metric Records object represents the association between document metrics and a Salesforce record.
| Field Name | Description |
|---|---|
| Entity Type | The Salesforce object type |
| Metric Date | The date that the metric was gathered (shown in your local time zone in Salesforce reports) |
| Metric Date Only | The date that the metric was gathered in UTC |
| Parent Record ID | The Salesforce parent record name. Admins who configure report types in CRM Analytics can use this field as a join to include additional data in the report. |
| Quip Document Metric | The Quip Document Metric record ID |
Collaboration Template Metrics
The Collaboration Template Metrics object captures the metrics for a Quip template document.
| Field Name | Description |
|---|---|
| Last Updated Date | The date that the template was created, last edited, or last shared (shown in your local time zone in Salesforce reports) |
| Last Updated Date Only | The date that the template was created, last edited, or last shared in UTC |
| Metric Date | The date that the metric was gathered (shown in your local time zone in Salesforce reports) |
| Metric Date Only | The date that the metric was gathered in UTC |
| Site | The Quip site ID |
| Template | The Quip template ID |
| Template Title | The Quip template title |
| Template URL | The Quip template URL |
| Total Document Count | The number of documents that were created from the template |
Collaboration Template Metric Records
The Collaboration Template Metric Records object represents the association between template metrics and a Salesforce record.
| Field Name | Description |
|---|---|
| Entity Type | The Salesforce object type |
| Metric Date | The date that the metric was gathered (shown in your local time zone in Salesforce reports) |
| Metric Date Only | The date that the metric was gathered in UTC |
| Parent Record ID | The Salesforce parent record name. Admins who configure report types in CRM Analytics can use this field as a join to include additional data in the report. |
| Quip Template Metric | The Quip Template Metric record ID |
Collaboration User Engagement Metrics
The Collaboration User Engagement Metrics object captures per-user engagement metrics for a Quip document, spreadsheet, or template.
| Field Name | Description |
|---|---|
| Comment Count | The number of comments that the user made on a given day |
| Edit Count | The number of edits that the user made on a given day. Any edits made over a 2-hour period are aggregated as one edit. A maximum of 12 edits per user per day are captured. |
| Metric Date | The date that the metric was gathered (shown in your local time zone in Salesforce reports) |
| Metric Date Only | The date that the metric was gathered in UTC |
| Quip User ID | The Quip user ID |
| SFDC User ID | The Salesforce user ID |
| Site ID | The Quip site ID |
| Source Template | The source template ID |
| Thread ID | The Quip document, spreadsheet, or template ID |
| Thread Title | The Quip document, spreadsheet, or template title |
| Thread Type | The type of Quip file: document, spreadsheet, or template |
| View Count | The number of documents that a user opens on a given day |
Collaboration User Engagement Records (Retired)
The CollabUserEngmntRecordLinks object was retired for the Winter ’22 release. You can collect the same data by using CRM Analytics to link the Collaboration User Engagement Metric to the Collaboration Document Metric Record.
- Connect Quip User Engagement Metrics to Salesforce Records
To associate Quip user engagement metrics with a Salesforce record, link the Collaboration User Engagement Metric object to the Collaboration Document Metric Record object.