Metrics Requests

Gets a statistic of API calls based on HTTP Method, then total number of calls, number of calls per user, number of calls by status code, number of calls by time, and the moving average of time taken for all API calls

Request

GET system/metrics/requests

Status Codes

200: A dictionary of API call info summary

Sample Response Body

{
  "SnapshotTimeStamp": "2020-09-02T00:48:53.2522592Z",
  "Requests": {
    "/": {
      "Methods": {
        "GET": {
          "Counts": {
            "0": 2,
            "10": 0,
            "50": 0,
            "100": 0,
            "250": 0,
            "500": 0,
            "750": 0,
            "1000": 0,
            "5000": 0,
            "30000": 0,
            "60000": 0,
            "120000": 0
          },
          "CountByUser": {
            "Domain\\user": 2
          },
          "CountByStatusCode": {
            "200": 2
          },
          "Total": 2,
          "LastObservedTime": "2020-09-02T00:48:43.1073053Z",
          "AvgTimeToFirstByte": 0.0
        }
      }
    },
    "/performancemetrics": {
      "Methods": {
        "GET": {
          "Counts": {
            "0": 0,
            "10": 1,
            "50": 0,
            "100": 0,
            "250": 0,
            "500": 0,
            "750": 0,
            "1000": 0,
            "5000": 1,
            "30000": 0,
            "60000": 0,
            "120000": 0
          },
          "CountByUser": {
            "Domain\\user": 2
          },
          "CountByStatusCode": {
            "200": 2
          },
          "Total": 2,
          "LastObservedTime": "2020-09-02T00:48:45.4082186Z",
          "AvgTimeToFirstByte": 29.0
        }
      }
    }
  },
  "Plugins": {
    "OMF": {
      "Children": {
        "OperationMetrics": {
          "Children": {
            "1.1": {
              "Counts": {
                "TypeMessages": 3,
                "ContainerMessages": 1,
                "StaticDataMessages": 0,
                "DynamicDataMessages": 2,
                "LinkDataMessages": 0
              }
            }
          }
        },
        "DAThroughputMetrics": {
          "Children": {
            "\\\\Your.PI.Server\\": {
              "Counts": {
                "PointsCreated": 7,
                "PointsUpdated": 0,
                "PointsDeleted": 0,
                "ValuesInserted": 21,
                "ValuesUpdated": 0,
                "ValuesRemoved": 0,
                "DigitalSetsCreated": 0,
                "DigitalSetsDeleted": 0
              }
            }
          }
        },
        "AFThroughputMetrics": {
          "Children": {
            "\\\\Your.AF.Database\\": {
              "Counts": {
                "ElementTemplatesCreated": 3,
                "ElementTemplatesDeleted": 0,
                "ElementsCreated": 2,
                "ElementsUpdated": 0,
                "ElementsDeleted": 0,
                "ElementsMoved": 0,
                "EnumerationSetsCreated": 0,
                "EnumerationSetsDeleted": 0,
                "PointReferenceAttributesCreated": 0,
                "PointReferenceAttributesUpdated": 3,
                "PointReferenceAttributesDeleted": 0
              }
            }
          }
        }
      }
    }
  }
}