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>b88fdba3-bb46-4a1c-a2ad-48007bfff9ff</ID> <MetricID>a753f6e9-d5dd-4556-9a0e-cb25c846d2cc</MetricID> <Date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-10-01T11:30:01.9465417Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </Date> <Value>1</Value> <MetricName>sample string 1</MetricName> <ArchiveID>0355c109-fb2e-40c0-81b2-cf771fe13f06</ArchiveID> <ArchiveName>sample string 2</ArchiveName> <ArchiveDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-10-01T11:30:01.9465417Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </ArchiveDate> </TrendValue>
{ "ID": "b88fdba3-bb46-4a1c-a2ad-48007bfff9ff", "MetricID": "a753f6e9-d5dd-4556-9a0e-cb25c846d2cc", "Date": "2025-10-01T11:30:01.9465417+00:00", "Value": 1.0, "MetricName": "sample string 1", "ArchiveID": "0355c109-fb2e-40c0-81b2-cf771fe13f06", "ArchiveName": "sample string 2", "ArchiveDate": "2025-10-01T11:30:01.9465417+00:00" }