GET api/admin/v{version}/server/metrics/start_recording?name={name}

Request Information

URI Parameters

Name	Description	Type	Additional information
name		string	Required
version		string	None.

Body Parameters

None.

Response Information

Resource Description

MetricRecord

Name	Type	Additional information
GUID	globally unique identifier	None.
StartTime	date	None.
EndTime	date	None.
Name	string	None.
Metrics	Dictionary of integer [key] and Dictionary of integer [key] and Dictionary of MetricType [key] and integer [value] [value] [value]	None.
Duration	time interval	None.

Response Formats

application/json, text/json

Sample:

{
  "GUID": "6f7b7d84-bafe-4636-9b8a-05da95d7ad4e",
  "StartTime": "2025-12-06T04:08:43.7375441+00:00",
  "EndTime": "2025-12-06T04:08:43.7375441+00:00",
  "Name": "sample string 2",
  "Metrics": {
    "1": {
      "1": {
        "REQUEST": 1
      },
      "2": {
        "REQUEST": 1
      }
    },
    "2": {
      "1": {
        "REQUEST": 1
      },
      "2": {
        "REQUEST": 1
      }
    }
  },
  "Duration": "00:00:00"
}

text/html

Sample:

{"GUID":"6f7b7d84-bafe-4636-9b8a-05da95d7ad4e","StartTime":"2025-12-06T04:08:43.7375441+00:00","EndTime":"2025-12-06T04:08:43.7375441+00:00","Name":"sample string 2","Metrics":{"1":{"1":{"REQUEST":1},"2":{"REQUEST":1}},"2":{"1":{"REQUEST":1},"2":{"REQUEST":1}}},"Duration":"00:00:00"}

application/xml, text/xml

Sample:

<MetricRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DispatchITV2.Models.ServerStats">
  <EndTime>2025-12-06T04:08:43.7375441+00:00</EndTime>
  <Metrics xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfKeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1ty7Ep6D1>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>
        <d2p1:KeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1>
          <d2p1:Key>1</d2p1:Key>
          <d2p1:Value>
            <d2p1:KeyValueOfMetricRecord.MetricTypeintWwy_PRAhi>
              <d2p1:Key>REQUEST</d2p1:Key>
              <d2p1:Value>1</d2p1:Value>
            </d2p1:KeyValueOfMetricRecord.MetricTypeintWwy_PRAhi>
          </d2p1:Value>
        </d2p1:KeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1>
        <d2p1:KeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1>
          <d2p1:Key>2</d2p1:Key>
          <d2p1:Value>
            <d2p1:KeyValueOfMetricRecord.MetricTypeintWwy_PRAhi>
              <d2p1:Key>REQUEST</d2p1:Key>
              <d2p1:Value>1</d2p1:Value>
            </d2p1:KeyValueOfMetricRecord.MetricTypeintWwy_PRAhi>
          </d2p1:Value>
        </d2p1:KeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfKeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1ty7Ep6D1>
    <d2p1:KeyValueOfintArrayOfKeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1ty7Ep6D1>
      <d2p1:Key>2</d2p1:Key>
      <d2p1:Value>
        <d2p1:KeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1>
          <d2p1:Key>1</d2p1:Key>
          <d2p1:Value>
            <d2p1:KeyValueOfMetricRecord.MetricTypeintWwy_PRAhi>
              <d2p1:Key>REQUEST</d2p1:Key>
              <d2p1:Value>1</d2p1:Value>
            </d2p1:KeyValueOfMetricRecord.MetricTypeintWwy_PRAhi>
          </d2p1:Value>
        </d2p1:KeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1>
        <d2p1:KeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1>
          <d2p1:Key>2</d2p1:Key>
          <d2p1:Value>
            <d2p1:KeyValueOfMetricRecord.MetricTypeintWwy_PRAhi>
              <d2p1:Key>REQUEST</d2p1:Key>
              <d2p1:Value>1</d2p1:Value>
            </d2p1:KeyValueOfMetricRecord.MetricTypeintWwy_PRAhi>
          </d2p1:Value>
        </d2p1:KeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfKeyValueOfintArrayOfKeyValueOfMetricRecord.MetricTypeintWwy_PRAhity7Ep6D1ty7Ep6D1>
  </Metrics>
  <Name>sample string 2</Name>
</MetricRecord>