Metric
metric
The Metric object defines a simple name/value pair entity for a metric.
Contents
Attributes
Caption | Name | Type | Is Array | Default | Description |
---|---|---|---|---|---|
Name | name | String | The name of the metric. | ||
Raw Data | raw_data | JSON | The event data as received from the event source. | ||
Record ID | record_id | String | Unique identifier for the object | ||
Unmapped Data | unmapped | Unmapped | The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source. | ||
Value | value | String | The value of the metric. |
References
Referenced By
Context
JSON
{
"caption": "Metric",
"description": "The Metric object defines a simple name/value pair entity for a metric.",
"extends": "object",
"name": "metric",
"attributes": {
"name": {
"description": "The name of the metric.",
"requirement": "required",
"caption": "Name",
"type": "string_t"
},
"value": {
"description": "The value of the metric.",
"requirement": "required",
"caption": "Value",
"type": "string_t"
},
"raw_data": {
"group": "context",
"caption": "Raw Data",
"description": "The event data as received from the event source.",
"type": "json_t"
},
"record_id": {
"description": "Unique identifier for the object",
"group": "primary",
"requirement": "required",
"caption": "Record ID",
"type": "string_t"
},
"unmapped": {
"caption": "Unmapped Data",
"description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.",
"type": "unmapped",
"is_array": true
}
}
}