{
  "endpoint": "AdministrativeHandler",
  "preferredHttpPath": "\u8D85",
  "alternateHttpPaths": [
    "HttpAdministrative"
  ],
  "summary": "Administrative APIs.",
  "description": "This endpoint contains all APIs related to administrative functionality.",
  "apis": [
    {
      "name": "GetSystemDashboard",
      "httpMethod": "GET",
      "httpPathRegex": "^/system-dashboard",
      "subPathPattern": "/system-dashboard",
      "summary": "Gets system stats.",
      "parameters": [
        {
          "name": "statisticIds",
          "required": true,
          "type": "String[]",
          "description": "An array of the desired statistic IDs."
        },
        {
          "name": "startRange",
          "required": false,
          "type": "DateOnly?",
          "description": "A <see cref=\"T:System.DateOnly\" /> indicating the start of the desired range.  Defaults to 30 days ago."
        },
        {
          "name": "endRange",
          "required": false,
          "type": "DateOnly?",
          "description": "A <see cref=\"T:System.DateOnly\" /> indicating the end of the desired range.  Defaults to today."
        }
      ],
      "return": {
        "type": "GetSystemStatsResponse",
        "description": "The <see cref=\"T:PicMeApi.GetSystemStatsResponse\" /> containing the response."
      }
    },
    {
      "name": "GetServerStats",
      "httpMethod": "GET",
      "httpPathRegex": "^/server-stats",
      "subPathPattern": "/server-stats",
      "summary": "Gets server stats.",
      "parameters": [
        {
          "name": "statisticIds",
          "required": true,
          "type": "String[]",
          "description": "An array of the desired statistic IDs."
        }
      ],
      "return": {
        "type": "GetServerStatsResponse",
        "description": "The <see cref=\"T:PicMeApi.GetServerStatsResponse\" /> containing the response."
      }
    },
    {
      "name": "ListAvailableSystemStats",
      "httpMethod": "GET",
      "httpPathRegex": "^/system-stats",
      "subPathPattern": "/system-stats",
      "summary": "Gets a list of the available system stats.",
      "parameters": [],
      "return": {
        "type": "ListAvailableSystemStatsResponse",
        "description": "The <see cref=\"T:PicMeApi.ListAvailableSystemStatsResponse\" /> containing the response."
      }
    }
  ],
  "types": [
    {
      "name": "GetSystemStatsResponse",
      "summary": "A record containing the response from <see cref=\"M:PicMeApi.AdministrativeApis.GetSystemDashboard(AmbientServices.Database,AmbientServices.IFileSystem,System.String[],System.Nullable{System.DateOnly},System.Nullable{System.DateOnly})\" />.",
      "type": "composite",
      "members": [
        {
          "name": "rangeInfo",
          "type": "StatsRangeInfo",
          "summary": "The <see cref=\"T:AmbientServices.StatsRangeInfo\" /> containing information about the range of statistics returned."
        },
        {
          "name": "stats",
          "type": "StatInfo[]",
          "summary": "An array of <see cref=\"T:AmbientServices.StatInfo\" /> containing the statistics samples for each requested statistic."
        }
      ]
    },
    {
      "name": "StatInfo",
      "type": "composite",
      "members": [
        {
          "name": "id",
          "type": "String"
        },
        {
          "name": "name",
          "type": "String"
        },
        {
          "name": "description",
          "type": "String"
        },
        {
          "name": "units",
          "type": "String?"
        },
        {
          "name": "fixedFloatingPointAdjustment",
          "type": "Double"
        },
        {
          "name": "preferredTemporalAggregationType",
          "type": "AggregationTypes"
        },
        {
          "name": "samples",
          "type": "Int32[]"
        }
      ]
    },
    {
      "name": "AggregationTypes",
      "type": "enum",
      "flags": true,
      "enumValues": [
        {
          "name": "None",
          "value": 0
        },
        {
          "name": "Sum",
          "value": 1
        },
        {
          "name": "Average",
          "value": 2
        },
        {
          "name": "Min",
          "value": 4
        },
        {
          "name": "Max",
          "value": 8
        },
        {
          "name": "MostRecent",
          "value": 16
        }
      ]
    },
    {
      "name": "StatsRangeInfo",
      "type": "composite",
      "members": [
        {
          "name": "start",
          "type": "DateTime"
        },
        {
          "name": "end",
          "type": "DateTime"
        },
        {
          "name": "durationPerSample",
          "type": "TimeSpan"
        }
      ]
    },
    {
      "name": "GetServerStatsResponse",
      "summary": "A record containing the response from <see cref=\"M:PicMeApi.AdministrativeApis.GetServerStats(AmbientServices.IFileSystem,System.String[])\" />."
    },
    {
      "name": "ListAvailableSystemStatsResponse",
      "summary": "A record containing the response from <see cref=\"M:PicMeApi.AdministrativeApis.ListAvailableSystemStats(AmbientServices.IFileSystem)\" />.",
      "type": "composite",
      "members": [
        {
          "name": "availableStats",
          "type": "Statistic[]",
          "summary": "An array of system statistics available to be queried using <see cref=\"M:PicMeApi.AdministrativeApis.GetSystemDashboard(AmbientServices.Database,AmbientServices.IFileSystem,System.String[],System.Nullable{System.DateOnly},System.Nullable{System.DateOnly})\" />."
        }
      ]
    },
    {
      "name": "Statistic",
      "summary": "Represents a system statistic with a name and a unique identifier.",
      "type": "composite",
      "members": [
        {
          "name": "id",
          "type": "String",
          "summary": "The unique identifier for the system statistic. Cannot be null."
        },
        {
          "name": "name",
          "type": "String",
          "summary": "The display name of the system statistic. Cannot be null."
        }
      ]
    }
  ]
}