afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/CollabDocumentMetric.json

76 lines
2.7 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields"
],
"title": "CollabDocumentMetric - Data API",
"description": "Represents the engagement metrics for a Quip thread (document or spreadsheet) thats linked to a Salesforce record. This object is available in API version 50.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"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."
}
}
}