GET api/Monitoring/{userId}

Retrieves status data for the latest plan runs on online endpoints, filtered by the specified user ID

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	Existing user id	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of MonitoringModels

Name	Description	Type	Additional information
PlanName	Plan name.	string	None.
CompanyName	Company name	string	None.
UserName	User email.	string	None.
UserID	User unique identifier	string	None.
ComputerName	Computer name.	string	None.
ComputerHid		string	None.
BuildVersion	Build version.	string	None.
StorageType	Storage type	string	None.
LastStart	Last start	date	None.
NextStart	Next run.	date	None.
Status	Status of plan.	MonitoringPlanStatus	None.
ErrorMessage	Error message.	string	None.
FilesCopied	Files Copied	integer	None.
FilesFailed	Files Failed	integer	None.
DataCopied	Size Data Copied	integer	None.
Duration	Duration of Operation	string	None.
DataToBackup	Size Data To Backup	integer	None.
TotalData	Size Total Data	integer	None.
FilesScanned	Files Scanned	integer	None.
FilesToBackup	Files To Backup	integer	None.
PlanId	Plan unique identifier	string	None.
PlanType	Plan Type	MonitoringPlanType	None.
DetailedReportLink	Detailed Report Link	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PlanName": "sample string 1",
    "CompanyName": "sample string 2",
    "UserName": "sample string 3",
    "UserID": "sample string 4",
    "ComputerName": "sample string 5",
    "ComputerHid": "sample string 6",
    "BuildVersion": "sample string 7",
    "StorageType": "sample string 8",
    "LastStart": "2025-10-29T23:50:47.2452858Z",
    "NextStart": "2025-10-29T23:50:47.2452858Z",
    "Status": 0,
    "ErrorMessage": "sample string 9",
    "FilesCopied": 10,
    "FilesFailed": 11,
    "DataCopied": 12,
    "Duration": "sample string 13",
    "DataToBackup": 14,
    "TotalData": 15,
    "FilesScanned": 16,
    "FilesToBackup": 17,
    "PlanId": "sample string 18",
    "PlanType": 0,
    "DetailedReportLink": "sample string 19"
  },
  {
    "PlanName": "sample string 1",
    "CompanyName": "sample string 2",
    "UserName": "sample string 3",
    "UserID": "sample string 4",
    "ComputerName": "sample string 5",
    "ComputerHid": "sample string 6",
    "BuildVersion": "sample string 7",
    "StorageType": "sample string 8",
    "LastStart": "2025-10-29T23:50:47.2452858Z",
    "NextStart": "2025-10-29T23:50:47.2452858Z",
    "Status": 0,
    "ErrorMessage": "sample string 9",
    "FilesCopied": 10,
    "FilesFailed": 11,
    "DataCopied": 12,
    "Duration": "sample string 13",
    "DataToBackup": 14,
    "TotalData": 15,
    "FilesScanned": 16,
    "FilesToBackup": 17,
    "PlanId": "sample string 18",
    "PlanType": 0,
    "DetailedReportLink": "sample string 19"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMonitoringModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <MonitoringModels>
    <BuildVersion>sample string 7</BuildVersion>
    <CompanyName>sample string 2</CompanyName>
    <ComputerHid>sample string 6</ComputerHid>
    <ComputerName>sample string 5</ComputerName>
    <DataCopied>12</DataCopied>
    <DataToBackup>14</DataToBackup>
    <DetailedReportLink>sample string 19</DetailedReportLink>
    <Duration>sample string 13</Duration>
    <ErrorMessage>sample string 9</ErrorMessage>
    <FilesCopied>10</FilesCopied>
    <FilesFailed>11</FilesFailed>
    <FilesScanned>16</FilesScanned>
    <FilesToBackup>17</FilesToBackup>
    <LastStart>2025-10-29T23:50:47.2452858Z</LastStart>
    <NextStart>2025-10-29T23:50:47.2452858Z</NextStart>
    <PlanId>sample string 18</PlanId>
    <PlanName>sample string 1</PlanName>
    <PlanType>NA</PlanType>
    <Status>Success</Status>
    <StorageType>sample string 8</StorageType>
    <TotalData>15</TotalData>
    <UserID>sample string 4</UserID>
    <UserName>sample string 3</UserName>
  </MonitoringModels>
  <MonitoringModels>
    <BuildVersion>sample string 7</BuildVersion>
    <CompanyName>sample string 2</CompanyName>
    <ComputerHid>sample string 6</ComputerHid>
    <ComputerName>sample string 5</ComputerName>
    <DataCopied>12</DataCopied>
    <DataToBackup>14</DataToBackup>
    <DetailedReportLink>sample string 19</DetailedReportLink>
    <Duration>sample string 13</Duration>
    <ErrorMessage>sample string 9</ErrorMessage>
    <FilesCopied>10</FilesCopied>
    <FilesFailed>11</FilesFailed>
    <FilesScanned>16</FilesScanned>
    <FilesToBackup>17</FilesToBackup>
    <LastStart>2025-10-29T23:50:47.2452858Z</LastStart>
    <NextStart>2025-10-29T23:50:47.2452858Z</NextStart>
    <PlanId>sample string 18</PlanId>
    <PlanName>sample string 1</PlanName>
    <PlanType>NA</PlanType>
    <Status>Success</Status>
    <StorageType>sample string 8</StorageType>
    <TotalData>15</TotalData>
    <UserID>sample string 4</UserID>
    <UserName>sample string 3</UserName>
  </MonitoringModels>
</ArrayOfMonitoringModels>