metric EntityType

Type of measurement for a goal, such as money amount or count.

Entity Set Path
[organization URI]/api/data/v9.0/metrics
Base Type
crmbaseentity
Display Name
Goal Metric
Primary Key
metricid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
amountdatatype Edm.Int32

Data type of the amount.

Display Name: Amount Data Type

Default Options
Value Label
0 Money
1 Decimal
2 Integer
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
description Edm.String

Description of the goal metric.

Display Name: Description

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

isamount Edm.Boolean

Information that indicates whether the metric type is Count or Amount.

Display Name: Metric Type

Default Options
Value Label
1 Amount
0 Count
isstretchtracked Edm.Boolean

Indicates whether the goal metric tracks stretch targets.

Display Name: Track Stretch Target

Default Options
Value Label
1 Yes
0 No
metricid Edm.Guid

Unique identifier of the goal metric.

Display Name: Goal Metric

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

Name of the goal metric.

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

statecode Edm.Int32

Status of the goal metric.

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the goal metric.

Display Name: Status Reason

Default Options
Value Label
0 Open
1 Closed
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version number of the goal metric.

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_organizationid_value organizationid

Unique identifier of the organization.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_metric_createdby
createdonbehalfby systemuser lk_metric_createdonbehalfby
modifiedby systemuser lk_metric_modifiedby
modifiedonbehalfby systemuser lk_metric_modifiedonbehalfby
organizationid organization organization_metric

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
metric_AsyncOperations asyncoperation regardingobjectid_metric
metric_goal goal metricid
metric_ProcessSessions processsession regardingobjectid_metric
metric_rollupfield rollupfield metricid
Metric_SyncErrors syncerror regardingobjectid_metric_syncerror

Solutions

The following solutions include the metric entity type.

Name Description
System Solution Internal CRM System Solution

See also