View shared data sources report

This report provides a consolidated view of the device data shared with users.

URL

https://apis.druva.com/platform/reporting/v1/reports/epSharedDevices

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epSharedDevices \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "userEmailID",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epSharedDevices as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "lastUpdatedTime": "2023-05-02T13:14:27.466Z",
      "deviceName": "mydevice-123",
      "userName": "user",
      "userEmailID": "[email protected]",
      "profileName": "Default",
      "lastCompletedBackup": "2023-05-02T13:14:27.466Z",
      "backupData": 1005,
      "sharedWith": "user3",
      "sharedOn": "2023-02-03T13:14:27.466Z",
      "autoDeleteOn": "2023-08-03T00:00:00.000Z"
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:22:20.563Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of shared data sources.
lastUpdatedTime	date-time	The last updated time stamp for a device. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z.
deviceName	string	The name of the user device shared with active users.
userName	string	The name of the preserved user whose device data is shared.
userEmailID	string	The mail-id of the preserved user.
profileName	string	The name of the profile that the user is associated with. Example - Default
lastCompleteBackup	date-time	The date and time on which data was last backed up for the user. Example - 2019-10-25T00:00:00Z
backupData	integer	The total data backed up by preserved user for the shared device.
sharedWith	string	The name of users with whom the device data is shared.
sharedOn	date-time	The date and time on which the device data is shared. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
autoDeleteOn	object	The date on which preserved user gets deleted automatically. Example - 2019-10-25
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	Filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View user provisioning report

This report provides information about the users provisioned under endpoints.

URL

https://apis.druva.com/platform/reporting/v1/reports/epUserProvisioning

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epUserProvisioning \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "userName",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epUserProvisioning as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "lastUpdatedTime": "2024-03-27T04:57:56.906Z",
      "userName": "user1",
      "userEmail": "[email protected]",
      "profile": "Default",
      "userStatus": "Active",
      "endpointsLicense": "Active",
      "endpointsUsageMB": 30520,
      "createdOn": "2022-08-03T13:21:27.960Z",
      "managedBy": "Manually",
      "customAttributeValue": "attributeVal",
      "customAttributeName": "attributeName"
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of user provisioning data.
lastUpdatedTime	date-time	The last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userName	string	The user name of the Endpoints user provisioned using the IdP.
userEmail	string	The email address of the user.
profile	string	The name of the profile the user is associated with in Endpoints.
userStatus	string	The user status in Endpoints.
endpointsLicense	string	The Endpoints license status. For example, active, preserved or -, wherein - represents the unlicensed state.
endpointsUsageMB	integer	The amount of data backed up by the user.
createdOn	date-time	The user account creation date in Endpoints. The time is in the UTC time zone.
managedBy	string	The name of IdP which is managing the user in Endpoints.
customAttributeValue	string	The value of the attribute in the AD server.
customAttributeName	string	Name of the attribute in the AD server.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	Filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View last backup status report

This report provides details of the last backup.

URL

https://apis.druva.com/platform/reporting/v1/reports/epLastBackupStatus

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epLastBackupStatus \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "status",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epLastBackupStatus as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "lastUpdatedTime": "2023-06-01T13:30:41.951Z",
      "userName": "user1",
      "userEmailID": "[email protected]",
      "device": "DESKTOP-SM857S52",
      "profile": "profileC",
      "clientVersion": "6.2.0",
      "osPlatform": "Windows",
      "deviceStatus": "Enabled",
      "startTime": "2023-06-01T13:30:41.951Z",
      "endTime": "2023-06-01T16:30:41.951Z",
      "filesBackedUp": 105,
      "filesMissed": 2,
      "status": "Success",
      "bytesTransferredMB": 12778,
      "deviceConnectivity": "Active",
      "timeTakenMinues": 18
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of backup statuses.
lastUpdatedTime	date-time	The last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userName	string	The name of the user.
userEmailID	string	The email address of the user.
device	string	The name of the device registered for the user.
profile	string	The profile that is assigned to the user.
clientVersion	string	The version of inSync client installed on the user's device.
osPlatform	string	The name, version, and platform details of the operating system running on the user's device.
deviceStatus	string	The backup status of the device. For example, Enabled.
startTime	date-time	The date and time on which the backup started. Example - 2019-10-25T00:00:00Z
endTime	date-time	The date and time on which the backup was completed. Example - 2019-10-25T00:00:00Z
filesBackedUp	integer	The number of files and folders that are backed up.
filesMissed	integer	The number of files and folders that Endpoints was not able to back up.
status	string	The status of the backup operation. A device can have the following backup statuses-Backup Failed, Never Backed Up, Backed Up With Errors, Backed Up Successfully.
bytesTransferredMB	integer	The number of bytes transferred during backup.
deviceConnectivity	string	Displays information about the device connectivity status - active or inactive.
timeTakenMinutes	integer	Displays the total time taken for the backup.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	Filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View upgrade activity report

This report lists the upgrade activity and associated status of all the inSync Client devices.

URL

https://apis.druva.com/platform/reporting/v1/reports/epUpgradeActivity

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epUpgradeActivity \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "profileName",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epUpgradeActivity as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "lastUpdatedTime": "2023-05-03T13:43:44.123Z",
      "deviceName": "DESKTOP-SM857S52",
      "userName": "user1",
      "userEmailID": "[email protected]",
      "profileName": "profileC",
      "deviceOS": "Mojave",
      "osPlatform": "darwin",
      "versionAtTheTimeOfUpgrade": "6.2.1",
      "upgradeTo": "6.2.2",
      "status": "Success",
      "details": "",
      "upgradeAttempt": "2023-05-04T13:43:44.123Z",
      "dateScheduledOn": "2023-05-05T13:43:44.123Z",
      "scheduledBy": "[email protected]",
      "typeOfUpgrade": "Manual upgrade"
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of upgrade activities.
lastUpdatedTime	string	The last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
deviceName	string	The name of the user device.
userName	string	The name of the user.
userEmailID	string	The email ID of the user to whom the device belongs.
profileName	string	The name of the profile with which the user is associated.
deviceOS	string	The operating system platform.
osPlatform	string	The operating system platform on the user device.
versionAtTheTimeOfUpgrade	string	The current inSync Client version when the upgrade is initiated.
upgradeTo	string	The inSync Client version being upgraded to.
status	string	The status of the upgrade operation. Example- Success, In progress, Failed, Scheduled
details	string	The details of the upgrade action.
upgradeAttempt	string	The date and time when the upgrade was triggered. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
dateScheduledOn	string	The date and time when the upgrade is scheduled. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
scheduledBy	string	The email-ID of cloud administrator/client who initiated the upgrade.
typeOfUpgrade	string	The type of upgrade initiated. - Manual upgrade: If a single device is marked for upgrade. - Bulk upgrade: If multiple devices are marked for upgrade. - Automatic upgrade: Triggered automatically if a new client version is available.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	Filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View alert report

This report provides details about all the alerts generated.

URL

https://apis.druva.com/platform/reporting/v1/reports/epAlert

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epAlert \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "lastOccurance",
        "operator": "LT",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epAlert as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "entity": "user_iobvl:DESKTOP-514PMN2",
      "alertDetails": "Misconfigured Backup Folder",
      "firstOccurence": "2022-12-01T13:50:35.369Z",
      "lastOccurence": "2023-01-01T13:50:35.369Z",
      "active": "No",
      "severity": "Warning"
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of alerts.
entity	string	The username and device of the user.
alertDetails	string	The details about the alert generated.
firstOccurence	string	The date and time when the alert was generated for the first time. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
lastOccurence	string	The date and time when the alert was generated for the last time. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
active	string	The information whether the alert generated is active or not.
severity	string	The severity type of the alert. Example:- critical, high, warning.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	The filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View restore activity report

This report provides details of all the restore activities performed during a specified period.

URL

https://apis.druva.com/platform/reporting/v1/reports/epRestoreActivity

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epRestoreActivity \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "filesSkipped",
        "operator": "GTE",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epRestoreActivity as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "lastUpdatedTime": "2023-02-05T14:07:52.080Z",
      "startTime": "2023-02-03T14:07:52.080Z",
      "endTime": "2023-02-04T14:07:52.080Z",
      "userName": "user1",
      "userEmailID": "[email protected]",
      "dataSource": "DESKTOP-514PMN2",
      "profile": "profileB",
      "mode": "Admin",
      "systemSettingRestore": "No",
      "files": 100,
      "filesSkipped": 8,
      "restoreSize": 1200,
      "status": "Restore done",
      "cplatform": "win32"
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},

Field	Type	Description
data	array of objects	The collection of restore activities.
lastUpdatedTime	string	The last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
startTime	string	The date and time on which the restore operation started. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
endTime	string	The date and time on which the restore operation was completed. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userName	string	The name of the user whose device is restored.
userEmailID	string	The email address of the user whose device is restored.
dataSource	string	The name of the device that is registered for the user.
profile	string	The profile that is assigned to the user.
mode	string	The type of restore operation based on its origin. For example, Admin, Web, self, or mobile.
systemSettingRestore	string	If the restore is performed with system settings this field will display the value as Yes, if not it will display as No.
files	integer	The number of files that were selected for the restore operation.
filesSkipped	integer	The number of files that were missed from the restore activity.
restoreSize	integer	The number of bytes in MB that were restored.
status	string	The status of the restore operation.
cplatform	string	The operating system of the device.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	The filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View deleted device report

This report provides details of the devices that are deleted from the Endpoints console.

URL

https://apis.druva.com/platform/reporting/v1/reports/epDeletedDevice

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epDeletedDevice \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "deviceName",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epDeletedDevice as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "lastUpdatedTime": "2023-06-02T14:20:43.242Z",
      "deviceName": "mydevice-123",
      "userName": "user1",
      "userStatus": "Deleted",
      "profileName": "profileA",
      "lastBackupStatus": "Backed Up Successfully",
      "lastCompletedBackup": "1683018325",
      "backupDataMB": 300,
      "deviceOS": "win32",
      "lastConnected": "1683017816",
      "deletedOn": "2023-06-05T14:20:43.242Z",
      "deletedBy": "testUser-abc",
      "userEmailID": "[email protected]",
      "customAttributeValue": "attrVal",
      "customAttributeName": "attrName"
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of deleted devices.
lastUpdatedTime	string	The last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
deviceName	string	The name of the deleted device.
userName	string	The name of the user whose device was deleted.
userStatus	string	The status of the user the deleted device is associated with. Example - Active, Preserved or Deleted.
profileName	string	The name of the profile the user is associated with.
lastBackupStatus	string	The status of the last backup of the device. If the backup completes successfully without any error, the status is displayed as Backed Up successfully. If the backup fails, the status is displayed as Backup Failed. If a backup was never performed on the device, the status is displayed as Never Backed Up.
lastCompletedBackup	string	The date and time when the last backup of the deleted device was completed. Example - 2019-10-25T00:00:00Z. The column shows blank for devices that have not yet connected to inSync Cloud or the first backup is yet to be complete.
backupDataMB	integer	The total size of backed-up data for the device. Total size is a combination of incremental and differential backup data for the device.
deviceOS	string	The operating system of the device.
lastConnected	string	The date and time when the device last connected to inSync Cloud. The column will show blank for devices that have not yet connected to inSync Cloud.
deletedOn	string	The date and time when the device was deleted. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z.
deletedBy	string	The details of the method used to delete the device. For example, if an Endpoints administrator has manually deleted the device, this column will display the Email address of the administrator.
userEmailID	string	The email address of the user whose device was deleted.
customAttributeValue	string	The name of the attribute in the AD server.
customAttributeName	string	The value of the attribute in the AD server.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	The filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View license usage report

This report provides details of the total number of users added, deleted, endpoints active, and preserved licenses allocated.

URL

https://apis.druva.com/platform/reporting/v1/reports/epLicenseUsage

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epLicenseUsage \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "fromDate",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epLicenseUsage as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "fromDate": "2022-06-03T14:34:11.532Z",
      "toDate": "2023-09-03T14:34:11.532Z",
      "usersAdded": 10,
      "usersDeleted": 3,
      "totalActiveLicense": 2,
      "activeLicenseUsed": 1,
      "totalPreservedLicense": 1,
      "preservedLicenseUsed": 1
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of license usage data.
fromDate	string	The start date of the weekly report or the monthly report (based on whether the report is weekly or monthly). The time is in the UTC time zone. Example: 2019-10-25T00:00:00Z00:00
toDate	string	The end date of the weekly report or the monthly report (based on whether the report is weekly or monthly). The time is in the UTC time zone. Example: 2019-10-25T00:00:00Z00:00
usersAdded	integer	The total number of users added for a given week or a given month.
usersDeleted	integer	The total number of users deleted for a given week or a given month (based on whether the report is weekly or monthly).
totalActiveLicense	integer	The total number of Endpoints active licenses that are allocated in Endpoints to date for a given week or a given month (based on whether the report is weekly or monthly).
activeLicenseUsed	integer	The total number of Endpoints active licenses that are consumed in Endpoints to date for a given week or a given month (based on whether the report is weekly or monthly).
totalPreservedLicense	integer	The total number of Endpoints preserved licenses that are allocated in Endpoints to date for a given week or a given month (based on whether the report is weekly or monthly).
preservedLicenseUsed	integer	The total number of Endpoints preserved licenses that are consumed in Endpoints to date for a given week or a given month (based on whether the report is weekly or monthly).
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	The filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View inactive devices report

This report provides inactive device details and auto-delete details for inactive devices.

URL

https://apis.druva.com/platform/reporting/v1/reports/epInactiveDevices

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epInactiveDevices \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "deviceName",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epInactiveDevices as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "lastUpdatedTime": "2023-06-03T15:03:30.412Z",
      "deviceName": "mydevice-1-8-9",
      "deviceStatus": "Enabled",
      "userName": "user1",
      "license": "Active",
      "profileName": "profileZ",
      "lastCompletedBackup": "2023-06-04T15:03:30.412Z",
      "lastConnected": "2023-06-05T15:03:30.412Z",
      "autoDeleteOn": "2023-08-03T16:47:36.000Z",
      "userEmailID": "[email protected]"
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of inactive devices data.
lastUpdatedTime	string	The last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
deviceName	string	The name of the inactive device as registered with Endpoints.
deviceStatus	string	The status assigned to the device in Endpoints. Can be enabled or disabled.
userName	string	The user name to whom the inactive device belongs.
license	string	The status of the license associated with the inactive device. For example, Active or Preserve.
profileName	string	The name of the profile associated with the inactive device.
lastCompletedBackup	string	The date and time when the last backup was completed from the inactive device. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z.
lastConnected	string	The date and time when the inactive device last connected to the inSync server. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z.
autoDeleteOn	string	The date when the inactive device is scheduled for auto-deletion. Example - 2019-10-25. This field is displayed if auto-delete inactive devices are enabled and configured.
userEmailID	string	The email ID of the user to whom the inactive device belongs.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	The filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View preserved users datasources report

This report provides information about the workloads that consumed preserve licenses, the date on which they were preserved, and the mode that was used to preserve them.

URL

https://apis.druva.com/platform/reporting/v1/reports/epPreservedUsersDatasources

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epPreservedUsersDatasources \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "preservedOn",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epPreservedUsersDatasources as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "lastUpdatedTime": "2023-06-03T15:03:30.412Z",
      "userName": "user5",
      "userEmailID": "[email protected]",
      "profileName": "profileC",
      "endpointsLicense": "Preserved",
      "preservedOn": "2023-06-03T15:03:30.412Z",
      "mode": "Manual",
      "autoDeleteOn": ""
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of preserved users data.
lastUpdatedTime	string	The last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userName	string	The username of the preserved user.
userEmailID	string	The email address of the preserved user.
profileName	string	The profile name assigned to the preserved user.
endpointsLicense	string	The Endpoints license status of the user. For example, preserved or "-" where"-" indicates as unlicensed state.
preservedOn	string	The date on which the user was preserved. The time is in the UTC time zone. Example - 2019-10-25
mode	string	The mode through which the user is preserved. - Manual: The user is manually marked as preserved through Endpoints. - AD/LDAP: The user is marked as preserved as part of AD/LDAP sync process. - SCIM: The user is marked as preserved as part of the SCIM sync process.
autoDeleteOn	string	The system calculated date on which the user will be deleted if endpoints are configured to auto-delete preserved users,.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	The filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View user rollout report

This report provides user devices, their activation date, and the status of first backup.

URL

https://apis.druva.com/platform/reporting/v1/reports/epUserRollout

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epUserRollout \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "profileName",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epUserRollout as the report ID under path params to test this API endpoint.

Sample HTTP responses

{
  "data": [
    {
      "lastUpdatedTime": "2023-06-02T15:03:30.412Z",
      "userName": "user1",
      "userEmail": "[email protected]",
      "customAttributeValue": "cust-attr-val",
      "customAttributeName": "cust-attr-name",
      "addedOn": "2023-04-03T15:03:30.412Z",
      "profileName": "profileC",
      "licenseData": "Active",
      "source": "DESKTOP-514PMN2",
      "activatedOn": "2023-04-03T16:47:36.000Z",
      "systemSettings": "Not Backed Up",
      "lastBackupStatus": "Backed Up Successfully",
      "lastBackupTime": "1685424078",
      "firstBackupStatus": "Complete",
      "firstBackupSizeMB": "128515",
      "bytesTransferredMB": "77240",
      "timeTakenHhMm": "0:00",
      "clientVersion": "6.2.0",
      "osPlatform": "Windows",
      "lastUpgradedOn": "",
      "upgradeState": "NOT UPGRADABLE",
      "deviceOS": "Win 10"
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of user rollout data.
lastUpdatedTime	string	The last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userName	string	The user name to whom the device belongs.
userEmail	string	The email ID of the user to whom the device belongs.
customAttributeValue	string	The value of the attribute in the AD server.
customAttributeName	string	The name of the attribute in the AD server.
addedOn	string	The date and time when the user was added. The time is in the UTC time zone.
profileName	string	The name of the profile with which the user is associated.
licenseData	string	The status of the license of the workload, the data source belongs to. For example, active, preserve or "-", where "-" indicates unlicensed state.
source	string	The name of the device which the user is associated with.
activatedOn	string	The date and time when the device was activated.
systemSettings	string	The status of whether the device's system settings were backed up.
lastBackupStatus	string	The status of the last backup operation.
lastBackupTime	string	The time taken(Unix format) for the last backup operation to complete in hours and minutes.
firstBackupStatus	string	The status of the first backup operation.
firstBackupSizeMB	string	The size of the files in MB that were backed up during the last backup operation.
bytesTransferredMB	string	The number of bytes transferred during backup.
timeTakenHhMm	string	The time taken for the backup operation to complete in hours and minutes.
clientVersion	string	The version of inSync Client on the user device.
osPlatform	string	The operating system platform on the user device.
lastUpgradedOn	string	The date and time when the inSync Client on the user device was last upgraded. Example - 2019-10-25T00:00:00Z.
upgradeState	string	The upgrade state of inSync Client on the user device. This field shows one of the following values- UPGRADEABLE, NOT UPGRADABLE, UPTODATE
deviceOS	string	The operating system platform on the user device.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	The filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View users report

This report provides the count of users added, deleted, and preserved for a specified period.

URL

https://apis.druva.com/platform/reporting/v1/reports/epUsers

Request type

HTTP POST

Sample cURL request

curl --request POST \
     --url https://apis.druva.com/platform/reporting/v1/reports/epUsers \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "usersPreserved",
        "operator": "EQUAL",
        "value": "string"
      }
    ]
  },
  "pageToken": ""
}
'

To try this API endpoint, see Reports API reference.

📘
Note
On the API reference page, select epUsers as the report ID under path params to test this API endpoint.

Sample responses

{
  "data": [
    {
      "fromDate": "2022-06-03T14:34:11.532Z",
      "toDate": "2023-09-03T14:34:11.532Z",
      "totalUsers": 7,
      "totalPreservedUsers": 3,
      "usersAdded": 10,
      "usersDeleted": 3,
      "usersPreserved": 3
    }
  ],
  "lastSyncTimestamp": "2024-03-27T04:57:56.906Z",
  "filters": {},
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}

Field	Type	Description
data	array of objects	The collection of user data.
fromDate	string	The start date of the weekly report or the monthly report (based on whether the report is weekly or monthly). The time is in the UTC time zone. Example- 2019-10-25T00:00:00Z00:00
toDate	string	The end date of the weekly report or the monthly report (based on whether the report is weekly or monthly). The time is in the UTC time zone. Example- 2019-10-25T00:00:00Z00:00
totalUsers	integer	The total number of users available in Endpoints for a given week or month.
totalPreservedUsers	integer	The total number of users that are preserved in Endpoints to date for a given week or month.
usersAdded	integer	The number of users that are added to Endpoints for a given week or month.
usersDeleted	integer	The number of users that are deleted from Endpoints for a given week or month.
usersPreserved	integer	The number of users that are preserved in Endpoints for a given week or month.
lastSyncTimestamp	date-time	The time stamp until which the report data was returned. The time is in the UTC time zone.
filters	object	The filters applied on the report.
nextPageToken	string	The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code.
data	object	Data of the error.
message	string	Error message.
retryable	boolean	Can retry the API call (`true` for yes and `false` for no.)

View shared data sources report

URL

Request type

Sample cURL request

📘Note

Sample responses

View user provisioning report

URL

Request type

Sample cURL request

📘Note

Sample responses

View last backup status report

URL

Request type

Sample cURL request

📘Note

Sample responses

View upgrade activity report

URL

Request type

Sample cURL request

📘Note

Sample responses

View alert report

URL

Request type

Sample cURL request

📘Note

Sample responses

View restore activity report

URL

Request type

Sample cURL request

📘Note

Sample responses

View deleted device report

URL

Request type

Sample cURL request

📘Note

Sample responses

View license usage report

URL

Request type

Sample cURL request

📘Note

Sample responses

View inactive devices report

URL

Request type

Sample cURL request

📘Note

Sample responses

View preserved users datasources report

URL

Request type

Sample cURL request

📘Note

Sample responses

View user rollout report

URL

Request type

Sample cURL request

📘Note

Sample HTTP responses

View users report

URL

Request type

Sample cURL request

📘Note

Sample responses

📘
Note

📘
Note

📘
Note

📘
Note

📘
Note

📘
Note

📘
Note

📘
Note

📘
Note

📘
Note

📘
Note

📘
Note