{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "MacroUsage - Data API",
"description": "Represents macro usage on a record, including which macro was used, who used it, and how they used it. This object is available in API version 47.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"AppContext": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Context in which the macro was run. Possible values are: Aloha—Salesforce Classic Lightning—Lightning Experience Unknown"
},
"ConditionCount": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "Number of conditional instructions contained in the macro at execution."
},
"ContextRecord": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the record on which the macro was run."
},
"DurationInMs": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The execution time, in milliseconds, for the macro."
},
"ExecutedInstructionCount": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The number of macro instructions that ran successfully. If the macro completed successfully, this value is the same as InstructionCount."
},
"ExecutionEndTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The time at which macro execution completed."
},
"ExecutionState": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The end state of macro execution. Possible values are SUCCESS FAILURE CANCELED"
},
"FailureReason": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "If ExecutionState is failure, this field stores the reason for the failure. Possible values are: ACCESS GENERIC TIMEOUT UNSUPPORTED"
},
"FolderId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the folder containing the macro at the time it was used."
},
"InstructionCount": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The number of instructions in the macro at the start of execution."
},
"IsFromBulk": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "If true, the macro was run as a bulk macro. When a bulk macro is run on multiple records, usage is recorded per record."
},
"MacroID": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "ID of the macro."
},
"Name": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "Name of the macro."
},
"OwnerId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "ID of the group or user that owns the macro."
},
"UserId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the user that ran the macro."
}
},
"special_access_rules": "This object is always read-only. Only users with “Modify All Data” permission can delete MacroUsage records.",
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **MacroUsageOwnerSharingRule**: Sharing rules are available for the object.\n- **MacroUsageShare**: Sharing is available for the object.",
"wsdl_segment": "```xml\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```",
"field_reference": {
"AppContext": {
"field_label": "App Context",
"type": "picklist",
"length": "255"
},
"ConditionCount": {
"field_label": "Condition Count",
"type": "int",
"digits": "9"
},
"ContextRecord": {
"field_label": "Context Record",
"type": "string",
"length": "18"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"DurationInMs": {
"field_label": "Duration In Milliseconds",
"type": "int",
"digits": "9"
},
"ExecutedInstructionCount": {
"field_label": "Executed Instruction Count",
"type": "int",
"digits": "9"
},
"ExecutionEndTime": {
"field_label": "Execution End Time",
"type": "datetime"
},
"ExecutionState": {
"field_label": "Execution State",
"type": "picklist",
"length": "255"
},
"FailureReason": {
"field_label": "Failure Reason",
"type": "picklist",
"length": "255"
},
"FolderId": {
"field_label": "Folder ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Macro Usage ID",
"type": "id",
"length": "18"
},
"InstructionCount": {
"field_label": "Instruction Count",
"type": "int",
"digits": "9"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsFromBulk": {
"field_label": "From Bulk Execution",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"MacroId": {
"field_label": "Macro ID",
"type": "reference",
"length": "18"
},
"Name": {
"field_label": "Macro Usage Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"UserId": {
"field_label": "User ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}