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

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
metricId `globally unique identifier` Required Guid ID of the metric for which to read data.	`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.	`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".	`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".	`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.	`byte` Add ?deleted=0, 1, or 2 for not deleted, deleted, or all.
tz `string` Optional parameter to set time zone information.	`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

Name	Description
ID `globally unique identifier` Required on Update ID of the Metric Data.	`globally unique identifier` Required on Update ID of the Metric Data.
MetricID `globally unique identifier` Required on Create ID of the metric.	`globally unique identifier` Required on Create ID of the metric.
Date `date` Required Date of the metric data	`date` Required Date of the metric data
Value `decimal number` Required Value of the metric data	`decimal number` Required Value of the metric data
MetricName `string` ReadOnly Name of the metric.	`string` ReadOnly Name of the metric.
ArchiveID `globally unique identifier` ReadOnly ID of the archive were the metric data is stored.	`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.	`string` ReadOnly Name of the archive were the metric data is stored.
ArchiveDate `date` ReadOnly Date the metric data was archived.	`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>d192f02b-5be4-4a55-8e19-9293fd01a3c5</ID>
  <MetricID>9c6663a6-eb89-40d3-b7f9-accc7dc9f872</MetricID>
  <Date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-24T07:49:45.7446944Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </Date>
  <Value>1</Value>
  <MetricName>sample string 1</MetricName>
  <ArchiveID>54755ff9-2681-4e48-a98b-c5efc6c52998</ArchiveID>
  <ArchiveName>sample string 2</ArchiveName>
  <ArchiveDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-24T07:49:45.7446944Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ArchiveDate>
</TrendValue>

application/json, text/json

Sample

{
  "ID": "d192f02b-5be4-4a55-8e19-9293fd01a3c5",
  "MetricID": "9c6663a6-eb89-40d3-b7f9-accc7dc9f872",
  "Date": "2024-10-24T07:49:45.7446944+00:00",
  "Value": 1.0,
  "MetricName": "sample string 1",
  "ArchiveID": "54755ff9-2681-4e48-a98b-c5efc6c52998",
  "ArchiveName": "sample string 2",
  "ArchiveDate": "2024-10-24T07:49:45.7446944+00:00"
}