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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "MessagingSessionMetrics - Data API",
  "description": "Represents a metric gathered about a specific enhanced messaging session, such as average agent response time. This object is available starting in October 2024 in API version 62.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "MessagingSessionId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the related messaging session. This field is a relationship field.",
      "relationship_name": "MessagingSession",
      "relationship_type": "Master-detail",
      "refers_to": "MessagingSession (the master object)"
    },
    "MessagingSessionMetricType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "The metric that this record captures. Possible values are: AgentMessageCount—The number of messages sent by the agent in the session. ServiceRepFirstResponseTime—The time when a Service rep sends their first response to a customer. AverageAgentResponseTime—The average number of seconds between an end user's message and the agent’s response in the session. AverageEndUserResponseTime—The average number of seconds between an agent or bot’s message and the end user's response in the session. EndUserMessageCount—The number of messages sent by the end user in the session. MaxAgentResponseTime—The longest span of time (in seconds) between an end user's message and the agent’s response in the session. MaxEndUserResponseTime— The longest span of time (in seconds) between an agent or bot’s message and the end user's response in the session. For each closed messaging session in enhanced Messaging channels and Messaging for In-App and Web, one MessagingSessionMetrics record is generated per MessagingSessionMetricType value. This means that six MessagingSessionMetrics records are generated per session."
    },
    "MessagingSessionMetricValue": {
      "type": "int",
      "properties": "Create, Filter, Group, Sort",
      "description": "The value of the measured metric. For example, if the MessagingSessionMetricType is EndUserMessageCount, a MessagingSessionMetricValue of 12 means that the end user sent 12 messages during the messaging session."
    },
    "Name": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "An autogenerated number identifying the MessagingSessionMetrics record."
    }
  },
  "special_access_rules": "Multiple MessagingSessionMetrics records are generated when a session ends in an enhanced Messaging channel or Messaging for In-App and Web channel. These records aren't generated for standard messaging sessions.",
  "wsdl_segment": "```xml\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<complexType name=\"MessagingSessionMetrics\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MessagingSession\" nillable=\"true\" minOccurs=\"0\" type=\"ens:MessagingSession\"/>\n        <element name=\"MessagingSessionId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"MessagingSessionMetricType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MessagingSessionMetricValue\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n```",
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Messaging Session Metrics ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MessagingSessionId": {
      "field_label": "Messaging Session ID",
      "type": "reference",
      "length": "18"
    },
    "MessagingSessionMetricType": {
      "field_label": "Messaging Session Metric Type",
      "type": "picklist",
      "length": "255"
    },
    "MessagingSessionMetricValue": {
      "field_label": "Messaging Session Metric Value",
      "type": "int",
      "digits": "9"
    },
    "Name": {
      "field_label": "Messaging Session Metrics Name",
      "type": "string",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}