ISVforce Guide

Introduction
ISVforce Quick Start
Designing and Building Your App
Packaging and Testing Your App
Passing the Security Review
Publish Your Offering on the AppExchange
Manage Orders
Managing Licenses
Provide a Free Trial
Supporting Your Customers
Subscriber Support Console
Usage Metrics
Setting up Usage Metrics
Accessing Usage Metrics Data
MetricsDataFile
Usage Metrics Visualization
Upgrading Your App
Appendices
Glossary
PDF

Newer Version Available

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

MetricsDataFile

Represents a data file containing usage metrics on all installations of a managed package in a Salesforce instance. This object is available in API version 30.0 and later.

Supported Calls

query(), delete()

Fields

Field Name Details
MetricsDataFile
Type
base64
Properties
Filter, Query, Sort
Description
A text file containing the usage data encoded in Base 64.
MetricsDataFileContentType
Type
string
Properties
Filter, Query, Sort
Description
The format of the data file. Currently, the only allowed value is text/csv.
MetricsDataFileLength
Type
int
Properties
Filter, Query, Sort
Description
The size of the data file in bytes.
MetricsRunDate
Type
dateTime
Properties
Filter, Query, Sort
Description
The date when the usage metrics collection job was run.
MetricsEndDate
Type
dateTime
Properties
Filter, Query, Sort
Description
The end time and date for the data collection.
MetricsStartDate
Type
dateTime
Properties
Filter, Query, Sort
Description
The start time and date for the data collection.
MetricsType
Type
picklist
Properties
Filter, Query, Sort
Description
The type of data being collected. The possible values are CustomObject and Visualforce.
NamespacePrefix
Type
string
Properties
Filter, Query, Sort
Description
The namespace prefix of the package for which data is being collected.
SendingInstance
Type
string
Properties
Filter, Query, Sort
Description
The server instance from which this data was collected, for example, “na8.”

Usage

Use this object to access customer usage metrics for a managed package. Each record contains one day’s data, on either custom objects or Visualforce pages, for all organizations in a Salesforce instance that have the package installed. The following data is collected each day.

  • Custom objects — the number of records stored in each custom object.
  • Visualforce pages — the number of times each Visualforce page was accessed, the number of unique users who accessed it, and the average loading time (in milliseconds).