Newer Version Available

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

Metric

The Metric object represents the components of a goal metric such as its name, metric type, and current value.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Name Details
CompletionDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The completion date of the metric.
CurrentValue
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
The current value of the metric.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the metric. The maximum length is 65,535 characters.
DueDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The due date of the metric.
GoalId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the goal the metric is related to.
InitialValue
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
The initial value of the metric.
IsCompletionMetric
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Read only. If true, the metric measures whether or not the metric is finished. If false, the metric measures how much is finished compared to a targeted value.
LastComment
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A comment that provides more context about the metric, such as its status or progress. The maximum length is 255 characters.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp that indicates when a user last viewed a record that is related to this metric.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp that indicates when a user last viewed this metric. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed.
Name
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the metric.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the user who owns the metric.
Progress
Type
percent
Properties
Filter, Nillable, Sort
Description
Read only. The overall progress of the metric.
RecordTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the related record type.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the metric. Possible values include:
  • Not Started
  • On Track
  • Behind
  • Critical
  • Completed
  • Postponed
  • Canceled
TargetValue
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
The target value of the metric.
Weight
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The weight of the metric. The sum of the weights should equal 100%.