Read metric data.
|
metricId
globally unique identifier
Required
Guid ID of the metric for which to read data. |
|
archiveId
globally unique identifier
Guid ID of the archive for which metric data is to be read. |
|
startDate
date
Start date of the metric data, in the format "yyyy-mm-dd". |
|
endDate
date
End date of the metric data, in the format "yyyy-mm-dd". |
|
deleted
byte
Add ?deleted=0, 1, or 2 for not deleted, deleted, or all. |
|
tz
string
Optional parameter to set time zone information. |
None.
|
ID
globally unique identifier
Required on Update
ID of the Metric Data. |
|
MetricID
globally unique identifier
Required on Create
ID of the metric. |
|
Date
date
Required
Date of the metric data |
|
Value
decimal number
Required
Value of the metric data |
|
MetricName
string
ReadOnly
Name of the metric. |
|
ArchiveID
globally unique identifier
ReadOnly
ID of the archive were the metric data is stored. |
|
ArchiveName
string
ReadOnly
Name of the archive were the metric data is stored. |
|
ArchiveDate
date
ReadOnly
Date the metric data was archived. |
<TrendValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
<ID>74821277-8770-4605-9e5c-20952b223a69</ID>
<MetricID>71f30e1c-f988-484c-b132-63baf8ea5ad4</MetricID>
<Date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-10-21T13:45:43.5701113Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</Date>
<Value>1</Value>
<MetricName>sample string 1</MetricName>
<ArchiveID>0b1cd628-67a8-470b-91f6-52a2f06d4752</ArchiveID>
<ArchiveName>sample string 2</ArchiveName>
<ArchiveDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-10-21T13:45:43.5701113Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ArchiveDate>
</TrendValue>
{
"ID": "74821277-8770-4605-9e5c-20952b223a69",
"MetricID": "71f30e1c-f988-484c-b132-63baf8ea5ad4",
"Date": "2025-10-21T13:45:43.5701113+00:00",
"Value": 1.0,
"MetricName": "sample string 1",
"ArchiveID": "0b1cd628-67a8-470b-91f6-52a2f06d4752",
"ArchiveName": "sample string 2",
"ArchiveDate": "2025-10-21T13:45:43.5701113+00:00"
}