Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

CollabDocumentMetric

Represents the engagement metrics for a Quip thread (document or spreadsheet) that’s linked to a Salesforce record. This object is available in API version 50.0 and later.

Supported Calls

describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

Field	Details
Document	Type string Properties Filter, Group, idLookup, Nillable, Sort Description The Quip thread ID.
Site	Type string Properties Filter, Group, Nillable, Sort Description The ID of the Quip site in which the thread is located.
SourceTemplate	Type string Properties Filter, Group, idLookup, Nillable, Sort Description The ID of the template (if any) on which a Quip thread is based.
DocumentTitle	Type string Properties Filter, Group, idLookup, Nillable, Sort Description The title of the thread.
MetricDate	Type dateTime Properties Filter, Nillable, Sort Description The date that the metric was gathered in your local time zone.
MetricDateOnly	Type date Properties Filter, Nillable, Sort Description The date that the metric was gathered in UTC. Available in API version 55.0 and later.
LastUpdatedDate	Type dateTime Properties Filter, Nillable, Sort Description The date that the thread was created, last edited, or last shared in your local time zone.
LastUpdatedDateOnly	Type date Properties Filter, Nillable, Sort Description The date that the thread was created, last edited, or last shared in UTC. Available in API version 55.0 and later.
ViewerCount	Type int Properties Filter, Nillable, Sort Description The number of thread views by user for the specified MetricDate.
UpdateCount	Type int Properties Filter, Group, Nillable, Sort Description The number of edits made on the thread on a given day.
EditorCount	Type int Properties Filter, Group, Nillable, Sort Description For the specified MetricDate, the number of users who edited the Quip thread.
CommenterCount	Type int Properties Filter, Group, Nillable, Sort Description For the specified MetricDate, the number of users who commented on the Quip thread.