Back

GET metrics/{id}?tz={tz}

Read a single metric.

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
id globally unique identifier Required

Guid ID of the metric to be read.
tz string

Body Parameters

None.

Response Information

Resource Description (Metric)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the given metric.
ParentID globally unique identifier

ID of the parent for the given metric.
AncestorID globally unique identifier Required on Create

ID of the ancestor for the given metric; organization, department, project, or individual.
Rank integer Required

Rank of the given metric.
Name string Required

Name of the given metric. (Max length 255 characters)
Description string Required

Description of the given metric.
Format string

Format of the number for the trend value. Examples can be found https://connectionsonline.zendesk.com/entries/21843291-Formatting-Metric-Examples. (Max length 255 characters, Default '0.#')
Color string

Hex value of the color for the given metric.
TColor1 string

First threshold hex value of the color for the given metric. (Max length 6 characters)
TColor2 string

Second threshold hex value of the color for the given metric. (Max length 6 characters)
TColor3 string

Third threshold hex value of the color for the given metric. (Max length 6 characters)
TColor4 string

Fourth threshold hex value of the color for the given metric. (Max length 6 characters)
Threshold1 decimal number

First Threshold of the given metric.
Threshold2 decimal number

Second threshold of the given metric.
Threshold3 decimal number

Third threshold of the given metric.
ColorByValue boolean

Color of the given metric.
Is8020 boolean

80/20 setting of the given metric.
SiteID globally unique identifier ReadOnly

ID of the site for the given metric.
AncestorType integer ReadOnly

Type of the ancestor for the metric; organization, project, or individual.
AncestorName string ReadOnly

Name of the ancestor for the given metric.
Deleted boolean ReadOnly

Deleted status of the given metric.
DeletedByRef boolean ReadOnly

Deleted by Ref status of the given metric.
Level integer ReadOnly

Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3
DisplayRank string ReadOnly

Rank that is displayed to the user.
RankPath Collection of byte ReadOnly

Current rank of the given metric in a byte array.
RankOrder string ReadOnly

Rank in string format, (0001.0001.0001) for the given organization/department.
Created date ReadOnly

Date the given metric was created.
CreatedBy globally unique identifier ReadOnly

ID of the individual who created the given metric.
Updated date ReadOnly

Date the given metric was updated.
UpdatedBy globally unique identifier ReadOnly

ID of the individual who updated the given metric.
DisplayColor string ReadOnly

Display color hex value entered for the given metric.
DisplayColorRank integer ReadOnly

Rank of the display color for the given metric. Based on either the current value/threshold or the custom entered color.
LatestDate date ReadOnly

Latest date a value was entered for the given metric.
LatestValue decimal number ReadOnly

Latest value of the given metric.
LatestValueColor string ReadOnly

Latest color hex value for the given metric, based on the current value.
LatestComment string ReadOnly

(Deprecated, replaced with LastComment) Latest comment of the metric.
Owners string ReadOnly

Owners of the given metric.
FormattedThreshold1 string ReadOnly

Minimum threshold of the given metric, formatted using the Format value.
FormattedThreshold2 string ReadOnly

Meets threshold of the given metric, formatted using the Format value.
FormattedThreshold3 string ReadOnly

Exceeds threshold of the given metric, formatted using the Format value.
FormattedLatestValue string ReadOnly

Current value of the given metric formatted using the Format value.
LastComment string ReadOnly

Body of the most recent comment on the given metric.
LastCommentDate date ReadOnly

Post date of the most recent comment on the given metric.
LastCommentByID globally unique identifier ReadOnly

User ID of the individual who posted the most recent comment on the given metric.
LastCommentBy string ReadOnly

Name of the individual who posted the most recent comment on the given metric.
DisplayColorName string ReadOnly

Name of the color to be displayed.
CanRead boolean ReadOnly

Read security setting for the object based on the current logged in user.
CanUpdate boolean ReadOnly

Update security setting for the object based on the current logged in user.
CanDelete boolean ReadOnly

Delete security setting for the object based on the current logged in user.
CanDelegate boolean ReadOnly

Delegate security setting for the object based on the current logged in user.
ColorRank integer ReadOnly

Rank of the color assigned to the given metric.
ColorName string ReadOnly

Name of the color to assigned to the given metric.
OwnerList Collection of MetricOwner ReadOnly

RollUp integer ReadOnly

Roll up status of a metric. 0 = Normal, 1 = Sum Roll up, 3 = Average Roll up
LinkedToID globally unique identifier ReadOnly

ID of the Linked Metric

Response Formats

application/xml, text/xml

Sample
<Metric xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>4993d3e5-a3d9-492a-b870-e6b776c150a9</ID>
  <ParentID>a1b382a4-6770-4591-b847-490420fd607c</ParentID>
  <AncestorID>3cc2d0b6-54b9-4fa1-8227-b5fa3667ba57</AncestorID>
  <Rank>1</Rank>
  <Name>sample string 2</Name>
  <Description>sample string 3</Description>
  <Format>sample string 4</Format>
  <Color>sample string 5</Color>
  <TColor1>sample string 6</TColor1>
  <TColor2>sample string 7</TColor2>
  <TColor3>sample string 8</TColor3>
  <TColor4>sample string 9</TColor4>
  <Threshold1>1</Threshold1>
  <Threshold2>1</Threshold2>
  <Threshold3>1</Threshold3>
  <ColorByValue>true</ColorByValue>
  <Is8020>true</Is8020>
  <SiteID>7607a289-ecc8-4822-8036-af8fde5304a2</SiteID>
  <AncestorType>1</AncestorType>
  <AncestorName>sample string 10</AncestorName>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Level>1</Level>
  <DisplayRank>sample string 11</DisplayRank>
  <RankPath>QEA=</RankPath>
  <RankOrder>sample string 12</RankOrder>
  <Created>2024-10-23T12:46:28.3624112+00:00</Created>
  <CreatedBy>d6e3d8d7-6171-4e45-bc60-15a976b574ac</CreatedBy>
  <Updated>2024-10-23T12:46:28.3624112+00:00</Updated>
  <UpdatedBy>9193fd12-9880-4552-aa19-0d43defa36ac</UpdatedBy>
  <DisplayColor>sample string 13</DisplayColor>
  <DisplayColorRank>1</DisplayColorRank>
  <LatestDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-23T12:46:28.3624112Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LatestDate>
  <LatestValue>1</LatestValue>
  <LatestValueColor>sample string 14</LatestValueColor>
  <LatestComment>sample string 15</LatestComment>
  <Owners>sample string 16</Owners>
  <FormattedThreshold1>sample string 17</FormattedThreshold1>
  <FormattedThreshold2>sample string 18</FormattedThreshold2>
  <FormattedThreshold3>sample string 19</FormattedThreshold3>
  <FormattedLatestValue>sample string 20</FormattedLatestValue>
  <LastComment>sample string 21</LastComment>
  <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-23T12:46:28.3624112Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>d7e06bb9-83fa-4d90-8398-0aed38d951d2</LastCommentByID>
  <LastCommentBy>sample string 22</LastCommentBy>
  <DisplayColorName>sample string 23</DisplayColorName>
  <CanRead>true</CanRead>
  <CanUpdate>true</CanUpdate>
  <CanDelete>true</CanDelete>
  <CanDelegate>true</CanDelegate>
  <ColorRank>1</ColorRank>
  <ColorName>sample string 24</ColorName>
  <OwnerList>
    <MetricOwner>
      <MetricID>a5b63d3f-d3f6-4ba8-8f91-4ef962c80d96</MetricID>
      <IndividualID>e9e4cd4d-c1f4-402f-be46-5d836e44812c</IndividualID>
      <ID>06b53bcf-0c2c-4118-a90f-2814095ce225</ID>
      <MetricName>sample string 1</MetricName>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <FullName>sample string 4</FullName>
      <Email>sample string 5</Email>
      <SiteID>06c6e294-88d8-4452-8b7b-b3045d8d7ffd</SiteID>
    </MetricOwner>
    <MetricOwner>
      <MetricID>a5b63d3f-d3f6-4ba8-8f91-4ef962c80d96</MetricID>
      <IndividualID>e9e4cd4d-c1f4-402f-be46-5d836e44812c</IndividualID>
      <ID>06b53bcf-0c2c-4118-a90f-2814095ce225</ID>
      <MetricName>sample string 1</MetricName>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <FullName>sample string 4</FullName>
      <Email>sample string 5</Email>
      <SiteID>06c6e294-88d8-4452-8b7b-b3045d8d7ffd</SiteID>
    </MetricOwner>
  </OwnerList>
  <RollUp>25</RollUp>
  <LinkedToID>d8bec5ac-a7c2-42a7-8123-dc2291c31846</LinkedToID>
</Metric>

application/json, text/json

Sample
{
  "ID": "4993d3e5-a3d9-492a-b870-e6b776c150a9",
  "ParentID": "a1b382a4-6770-4591-b847-490420fd607c",
  "AncestorID": "3cc2d0b6-54b9-4fa1-8227-b5fa3667ba57",
  "Rank": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Format": "sample string 4",
  "Color": "sample string 5",
  "TColor1": "sample string 6",
  "TColor2": "sample string 7",
  "TColor3": "sample string 8",
  "TColor4": "sample string 9",
  "Threshold1": 1.0,
  "Threshold2": 1.0,
  "Threshold3": 1.0,
  "ColorByValue": true,
  "Is8020": true,
  "SiteID": "7607a289-ecc8-4822-8036-af8fde5304a2",
  "AncestorType": 1,
  "AncestorName": "sample string 10",
  "Deleted": true,
  "DeletedByRef": true,
  "Level": 1,
  "DisplayRank": "sample string 11",
  "RankPath": "QEA=",
  "RankOrder": "sample string 12",
  "Created": "2024-10-23T12:46:28.3624112+00:00",
  "CreatedBy": "d6e3d8d7-6171-4e45-bc60-15a976b574ac",
  "Updated": "2024-10-23T12:46:28.3624112+00:00",
  "UpdatedBy": "9193fd12-9880-4552-aa19-0d43defa36ac",
  "DisplayColor": "sample string 13",
  "DisplayColorRank": 1,
  "LatestDate": "2024-10-23T12:46:28.3624112+00:00",
  "LatestValue": 1.0,
  "LatestValueColor": "sample string 14",
  "LatestComment": "sample string 15",
  "Owners": "sample string 16",
  "FormattedThreshold1": "sample string 17",
  "FormattedThreshold2": "sample string 18",
  "FormattedThreshold3": "sample string 19",
  "FormattedLatestValue": "sample string 20",
  "LastComment": "sample string 21",
  "LastCommentDate": "2024-10-23T12:46:28.3624112+00:00",
  "LastCommentByID": "d7e06bb9-83fa-4d90-8398-0aed38d951d2",
  "LastCommentBy": "sample string 22",
  "DisplayColorName": "sample string 23",
  "CanRead": true,
  "CanUpdate": true,
  "CanDelete": true,
  "CanDelegate": true,
  "ColorRank": 1,
  "ColorName": "sample string 24",
  "OwnerList": [
    {
      "MetricID": "a5b63d3f-d3f6-4ba8-8f91-4ef962c80d96",
      "IndividualID": "e9e4cd4d-c1f4-402f-be46-5d836e44812c",
      "ID": "06b53bcf-0c2c-4118-a90f-2814095ce225",
      "MetricName": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "Email": "sample string 5",
      "SiteID": "06c6e294-88d8-4452-8b7b-b3045d8d7ffd"
    },
    {
      "MetricID": "a5b63d3f-d3f6-4ba8-8f91-4ef962c80d96",
      "IndividualID": "e9e4cd4d-c1f4-402f-be46-5d836e44812c",
      "ID": "06b53bcf-0c2c-4118-a90f-2814095ce225",
      "MetricName": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "Email": "sample string 5",
      "SiteID": "06c6e294-88d8-4452-8b7b-b3045d8d7ffd"
    }
  ],
  "RollUp": 25,
  "LinkedToID": "d8bec5ac-a7c2-42a7-8123-dc2291c31846"
}