POST metrics

Request Information

URI Parameters

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

None.

Body Parameters (Metric)

This object takes all the parameters needed to create a new metric.

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

Request Formats

application/xml, text/xml

Sample

<Metric xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>1e4286e9-5b18-41b7-affd-c8712bd435a9</ID>
  <ParentID>fa61e06d-61a0-4ce9-9112-4cc799bbd65a</ParentID>
  <AncestorID>33c3d66e-8190-4b93-a5e3-7cb74669cb10</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>
  <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>2026-09-04T06:44:35.0664479Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>42487311-6a93-439b-b945-96336078a39b</LastCommentByID>
  <LastCommentBy>sample string 22</LastCommentBy>
  <DisplayColorName>sample string 23</DisplayColorName>
  <ColorName>sample string 24</ColorName>
  <OwnerList>
    <MetricOwner>
      <MetricID>9f7dca49-d86c-4fe1-8546-a83b751e5e37</MetricID>
      <IndividualID>3eb5cdb1-b6de-47b6-a509-e9c36a538bcc</IndividualID>
    </MetricOwner>
    <MetricOwner>
      <MetricID>9f7dca49-d86c-4fe1-8546-a83b751e5e37</MetricID>
      <IndividualID>3eb5cdb1-b6de-47b6-a509-e9c36a538bcc</IndividualID>
    </MetricOwner>
  </OwnerList>
  <RollUp>25</RollUp>
  <LinkedToID>16c54e8e-466f-4700-b869-f755978036c1</LinkedToID>
</Metric>

application/json, text/json

Sample

{"ID":"1e4286e9-5b18-41b7-affd-c8712bd435a9","ParentID":"fa61e06d-61a0-4ce9-9112-4cc799bbd65a","AncestorID":"33c3d66e-8190-4b93-a5e3-7cb74669cb10","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,"FormattedThreshold1":"sample string 17","FormattedThreshold2":"sample string 18","FormattedThreshold3":"sample string 19","FormattedLatestValue":"sample string 20","LastComment":"sample string 21","LastCommentDate":"2026-09-04T06:44:35.0664479+00:00","LastCommentByID":"42487311-6a93-439b-b945-96336078a39b","LastCommentBy":"sample string 22","DisplayColorName":"sample string 23","ColorName":"sample string 24","OwnerList":[{"MetricID":"9f7dca49-d86c-4fe1-8546-a83b751e5e37","IndividualID":"3eb5cdb1-b6de-47b6-a509-e9c36a538bcc","IndividualID":"3eb5cdb1-b6de-47b6-a509-e9c36a538bcc","RollUp":25,"LinkedToID":"16c54e8e-466f-4700-b869-f755978036c1"}

Response Information

Resource Description (Metric)

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

Response Formats

application/xml, text/xml

Sample

<Metric xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>270b9e44-b4b1-4862-8b06-a95d62b45be3</ID>
  <ParentID>f7eecee5-5793-4ee7-8c8f-d6131fabe71f</ParentID>
  <AncestorID>77c5dc33-b31c-400d-b2be-452378e23260</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>06cfc498-8729-43ea-b7ee-ea8b135d1f07</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>2026-09-04T06:44:35.0664479+00:00</Created>
  <CreatedBy>ba2938f8-ec80-45a0-92d2-0dae1c449dde</CreatedBy>
  <Updated>2026-09-04T06:44:35.0664479+00:00</Updated>
  <UpdatedBy>861b3b37-8eb7-4098-afb5-8ae6e9f8c501</UpdatedBy>
  <DisplayColor>sample string 13</DisplayColor>
  <DisplayColorRank>1</DisplayColorRank>
  <LatestDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-09-04T06:44:35.0664479Z</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>2026-09-04T06:44:35.0664479Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>f1af5438-8aec-4a8d-9f39-3b2601dc8f4f</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>4e892c23-f0da-4ae7-a3e7-b7f3f1be3dc5</MetricID>
      <IndividualID>2dac970d-1cda-4e11-8804-a6a93a3124fb</IndividualID>
      <ID>c2fb1539-80c7-4c1e-bed4-ab410be1a6cb</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>97bbb971-1a74-4d22-beb4-9c9c73e98ae1</SiteID>
    </MetricOwner>
    <MetricOwner>
      <MetricID>4e892c23-f0da-4ae7-a3e7-b7f3f1be3dc5</MetricID>
      <IndividualID>2dac970d-1cda-4e11-8804-a6a93a3124fb</IndividualID>
      <ID>c2fb1539-80c7-4c1e-bed4-ab410be1a6cb</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>97bbb971-1a74-4d22-beb4-9c9c73e98ae1</SiteID>
    </MetricOwner>
  </OwnerList>
  <RollUp>25</RollUp>
  <LinkedToID>2f35272b-843e-4e2b-92f9-df92f7739d5d</LinkedToID>
</Metric>

application/json, text/json

Sample

{
  "ID": "270b9e44-b4b1-4862-8b06-a95d62b45be3",
  "ParentID": "f7eecee5-5793-4ee7-8c8f-d6131fabe71f",
  "AncestorID": "77c5dc33-b31c-400d-b2be-452378e23260",
  "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": "06cfc498-8729-43ea-b7ee-ea8b135d1f07",
  "AncestorType": 1,
  "AncestorName": "sample string 10",
  "Deleted": true,
  "DeletedByRef": true,
  "Level": 1,
  "DisplayRank": "sample string 11",
  "RankPath": "QEA=",
  "RankOrder": "sample string 12",
  "Created": "2026-09-04T06:44:35.0664479+00:00",
  "CreatedBy": "ba2938f8-ec80-45a0-92d2-0dae1c449dde",
  "Updated": "2026-09-04T06:44:35.0664479+00:00",
  "UpdatedBy": "861b3b37-8eb7-4098-afb5-8ae6e9f8c501",
  "DisplayColor": "sample string 13",
  "DisplayColorRank": 1,
  "LatestDate": "2026-09-04T06:44:35.0664479+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": "2026-09-04T06:44:35.0664479+00:00",
  "LastCommentByID": "f1af5438-8aec-4a8d-9f39-3b2601dc8f4f",
  "LastCommentBy": "sample string 22",
  "DisplayColorName": "sample string 23",
  "CanRead": true,
  "CanUpdate": true,
  "CanDelete": true,
  "CanDelegate": true,
  "ColorRank": 1,
  "ColorName": "sample string 24",
  "OwnerList": [
    {
      "MetricID": "4e892c23-f0da-4ae7-a3e7-b7f3f1be3dc5",
      "IndividualID": "2dac970d-1cda-4e11-8804-a6a93a3124fb",
      "ID": "c2fb1539-80c7-4c1e-bed4-ab410be1a6cb",
      "MetricName": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "Email": "sample string 5",
      "SiteID": "97bbb971-1a74-4d22-beb4-9c9c73e98ae1"
    },
    {
      "MetricID": "4e892c23-f0da-4ae7-a3e7-b7f3f1be3dc5",
      "IndividualID": "2dac970d-1cda-4e11-8804-a6a93a3124fb",
      "ID": "c2fb1539-80c7-4c1e-bed4-ab410be1a6cb",
      "MetricName": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "Email": "sample string 5",
      "SiteID": "97bbb971-1a74-4d22-beb4-9c9c73e98ae1"
    }
  ],
  "RollUp": 25,
  "LinkedToID": "2f35272b-843e-4e2b-92f9-df92f7739d5d"
}

Name	Description
ID `globally unique identifier` Required on Update ID of the given metric.	`globally unique identifier` Required on Update ID of the given metric.
ParentID `globally unique identifier` ID of the parent for the given metric.	`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.	`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.	`integer` Required Rank of the given metric.
Name `string` Required Name of the given metric. (Max length 255 characters)	`string` Required Name of the given metric. (Max length 255 characters)
Description `string` Required Description of the given metric.	`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.#')	`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.	`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)	`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)	`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)	`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)	`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.	`decimal number` First Threshold of the given metric.
Threshold2 `decimal number` Second threshold of the given metric.	`decimal number` Second threshold of the given metric.
Threshold3 `decimal number` Third threshold of the given metric.	`decimal number` Third threshold of the given metric.
ColorByValue `boolean` Color of the given metric.	`boolean` Color of the given metric.
Is8020 `boolean` 80/20 setting of the given metric.	`boolean` 80/20 setting of the given metric.
SiteID `globally unique identifier` ReadOnly ID of the site for the given metric.	`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.	`integer` ReadOnly Type of the ancestor for the metric; organization, project, or individual.
AncestorName `string` ReadOnly Name of the ancestor for the given metric.	`string` ReadOnly Name of the ancestor for the given metric.
Deleted `boolean` ReadOnly Deleted status of the given metric.	`boolean` ReadOnly Deleted status of the given metric.
DeletedByRef `boolean` ReadOnly Deleted by Ref status of the given metric.	`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	`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.	`string` ReadOnly Rank that is displayed to the user.
RankPath `Collection of byte` ReadOnly Current rank of the given metric in a byte array.	`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.	`string` ReadOnly Rank in string format, (0001.0001.0001) for the given organization/department.
Created `date` ReadOnly Date the given metric was created.	`date` ReadOnly Date the given metric was created.
CreatedBy `globally unique identifier` ReadOnly ID of the individual who created the given metric.	`globally unique identifier` ReadOnly ID of the individual who created the given metric.
Updated `date` ReadOnly Date the given metric was updated.	`date` ReadOnly Date the given metric was updated.
UpdatedBy `globally unique identifier` ReadOnly ID of the individual who updated the given metric.	`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.	`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.	`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.	`date` ReadOnly Latest date a value was entered for the given metric.
LatestValue `decimal number` ReadOnly Latest value of the given metric.	`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.	`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.	`string` ReadOnly (Deprecated, replaced with LastComment) Latest comment of the metric.
Owners `string` ReadOnly Owners of the given metric.	`string` ReadOnly Owners of the given metric.
FormattedThreshold1 `string` ReadOnly Minimum threshold of the given metric, formatted using the Format value.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`integer` ReadOnly Rank of the color assigned to the given metric.
ColorName `string` ReadOnly Name of the color to assigned to the given metric.	`string` ReadOnly Name of the color to assigned to the given metric.
OwnerList `Collection of MetricOwner` ReadOnly	`Collection of MetricOwner` ReadOnly
RollUp `integer` ReadOnly Roll up status of a metric. 0 = Normal, 1 = Sum Roll up, 3 = Average Roll up	`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	`globally unique identifier` ReadOnly ID of the Linked Metric