PlatformEventMetrics

This object is available in API version 36.0 and later.

Supported Calls

query()

Special Access Rules

tbd

Fields

Field	Details
AggregationFieldName	Type string Properties Nillable Description Optional. The name of the field on which you’re collecting metrics.
AggregationFieldValue	Type string Properties Filter, Nillable, Sort Description Optional. The value of the field on which you’re collecting metrics.
EventType	Type string Properties Nillable, Restricted picklist Description The name of the event type for which you’re calculating metrics. The value is a LoginEvent or an ApexLimitEvent.
MetricDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time stamp of when the metrics were collected.
MetricType	Type string Properties Filter, Nillable, Restricted picklist, Sort Description The type of data that you’re collecting. For a full description of the available metric types and their use cases, see Metrics Types.
MetricValue	Type double Properties Nillable Description The value of the metric data.

Metrics Types

The MetricType field on PlatformEventMetrics stores LoginEvent metric types. In the context of login forensics, metrics are roll-up aggregations of events over time. Use metrics to recognize atypical behavior in your organization.

This table outlines the available metrics.

Metric Type	Description
NumLogins	Label Count of logins Use See how many logins were attempted. Rapid increase of logins could indicate an increased work period (for example, the end of the quarter) or malicious log in activity to the organization. Aggregation Field Name null Aggregation Field Value Example N/A
NumDistinctLogins	Label Count of distinct logins Use See how many unique users logged in. Aggregation Field Name null Aggregation Field Value Example N/A
NumLoginsByUser	Label Count of logins by user Use See how many times a user logged in. Rapid increase of logins could indicate that multiple users are using the same login credentials. Aggregation Field Name UserId Aggregation Field Value Example 00500000000Nv1G
NumDistinctIps	Label Count of distinct IPs Use See how many IP ranges were used by all users. You can use this metric to create a network topology map of your users. Aggregation Field Name null Aggregation Field Value Example N/A
NumDistinctIpsByUser	Label Count of distinct IPs by user Use See how many IP ranges were used by each user. Aggregation Field Name UserId Aggregation Field Value Example 00500000000Nv1G
NumDistinctUsersByIP	Label Count of distinct users by IP Use See how many users share IP ranges. Aggregation Field Name SourceIp Aggregation Field Value Example 10.1.1.2
NumDistinctBrowsersByUser	Label Count of distinct browsers by user Use See how many browsers each user accessed. Rapid increase of browsers could indicate that the account has been compromised. Aggregation Field Name UserId Aggregation Field Value Example 00500000000Nv1G
NumDistinctUsersByBrowser	Label Count of distinct users by browser Use See the number of users per browser. This metric identifies adoption trends for browsers. Aggregation Field Name Browser Aggregation Field Value Example Chrome 33
NumDistinctUsersByApplication	Label Count of distinct users by application Use See the number of users per application. This metric identifies adoption trends for browsers. Aggregation Field Name Application Aggregation Field Value Example 1000 (browser logins)
NumDistinctApplicationsByUser	Label Count of distinct applications by user Use See how many applications each user used. Rapid increase of applications could indicate that the account has been compromised. Aggregation Field Name UserId Aggregation Field Value Example 00500000000Nv1G
NumDistinctUsersByLoginUrl	Label Count of distinct users by login URL Use See how many users logged in with a specific URL. This metric identifies adoption trends for login entry points. Aggregation Field Name LoginUrl Aggregation Field Value Example na1.salesforce.com
NumDistinctLoginUrlsByUser	Label Count of distinct LoginUrls by user Use See how many login URLs were used by each user. Rapid increase of logins from a URL could indicate that the account has been compromised. Aggregation Field Name UserId Aggregation Field Value Example 00500000000Nv1G
NumDistinctUsersByPlatform	Label Count of distinct users by platform Use See the number of users per platform. This field identifies adoption trends for platforms in the organization. Aggregation Field Name null Aggregation Field Value Example N/A
NumDistinctPlatformsByUser	Label Count of distinct platforms by user Use See how many platforms each user accessed. Rapid increase of platforms or known unsupported platforms could indicate that the account has been compromised. Aggregation Field Name UserId Aggregation Field Value Example 00500000000Nv1G

Object Reference for Salesforce and Force.com

Supported Calls

Special Access Rules

Fields

Metrics Types

SOQL Usage