Back

GET metrics/{metricId}/values?archiveId={archiveId}&startDate={startDate}&endDate={endDate}&deleted={deleted}&tz={tz}

Read metric data.

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
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.

Body Parameters

None.

Response Information

Resource Description (TrendValue)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
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.

Response Formats

application/xml, text/xml

Sample
<TrendValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>cc774142-ca71-4790-a75b-f8e6df90b1d8</ID>
  <MetricID>cbb30486-df88-48d6-a0aa-a03d465011cf</MetricID>
  <Date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-10-23T08:10:03.5513054Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </Date>
  <Value>1</Value>
  <MetricName>sample string 1</MetricName>
  <ArchiveID>e42c4417-201c-46b5-bf7a-05062335b564</ArchiveID>
  <ArchiveName>sample string 2</ArchiveName>
  <ArchiveDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-10-23T08:10:03.5513054Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ArchiveDate>
</TrendValue>

application/json, text/json

Sample
{
  "ID": "cc774142-ca71-4790-a75b-f8e6df90b1d8",
  "MetricID": "cbb30486-df88-48d6-a0aa-a03d465011cf",
  "Date": "2025-10-23T08:10:03.5513054+00:00",
  "Value": 1.0,
  "MetricName": "sample string 1",
  "ArchiveID": "e42c4417-201c-46b5-bf7a-05062335b564",
  "ArchiveName": "sample string 2",
  "ArchiveDate": "2025-10-23T08:10:03.5513054+00:00"
}