Get reports on endpoints

The reports that provide data on endpoints such as devices and data from SaaS apps.

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="
}
FieldTypeDescription
dataarray of objectsThe collection of shared data sources.
lastUpdatedTimedate-timeThe last updated time stamp for a device. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z.
deviceNamestringThe name of the user device shared with active users.
userNamestringThe name of the preserved user whose device data is shared.
userEmailIDstringThe mail-id of the preserved user.
profileNamestringThe name of the profile that the user is associated with. Example - Default
lastCompleteBackupdate-timeThe date and time on which data was last backed up for the user. Example - 2019-10-25T00:00:00Z
backupDataintegerThe total data backed up by preserved user for the shared device.
sharedWithstringThe name of users with whom the device data is shared.
sharedOndate-timeThe date and time on which the device data is shared. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
autoDeleteOnobjectThe date on which preserved user gets deleted automatically. Example - 2019-10-25
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectFilters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of user provisioning data.
lastUpdatedTimedate-timeThe last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userNamestringThe user name of the Endpoints user provisioned using the IdP.
userEmailstringThe email address of the user.
profilestringThe name of the profile the user is associated with in Endpoints.
userStatusstringThe user status in Endpoints.
endpointsLicensestringThe Endpoints license status. For example, active, preserved or -, wherein - represents the unlicensed state.
endpointsUsageMBintegerThe amount of data backed up by the user.
createdOndate-timeThe user account creation date in Endpoints. The time is in the UTC time zone.
managedBystringThe name of IdP which is managing the user in Endpoints.
customAttributeValuestringThe value of the attribute in the AD server.
customAttributeNamestringName of the attribute in the AD server.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectFilters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of backup statuses.
lastUpdatedTimedate-timeThe last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userNamestringThe name of the user.
userEmailIDstringThe email address of the user.
devicestringThe name of the device registered for the user.
profilestringThe profile that is assigned to the user.
clientVersionstringThe version of inSync client installed on the user's device.
osPlatformstringThe name, version, and platform details of the operating system running on the user's device.
deviceStatusstringThe backup status of the device. For example, Enabled.
startTimedate-timeThe date and time on which the backup started. Example - 2019-10-25T00:00:00Z
endTimedate-timeThe date and time on which the backup was completed. Example - 2019-10-25T00:00:00Z
filesBackedUpintegerThe number of files and folders that are backed up.
filesMissedintegerThe number of files and folders that Endpoints was not able to back up.
statusstringThe 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.
bytesTransferredMBintegerThe number of bytes transferred during backup.
deviceConnectivitystringDisplays information about the device connectivity status - active or inactive.
timeTakenMinutesintegerDisplays the total time taken for the backup.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectFilters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of upgrade activities.
lastUpdatedTimestringThe last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
deviceNamestringThe name of the user device.
userNamestringThe name of the user.
userEmailIDstringThe email ID of the user to whom the device belongs.
profileNamestringThe name of the profile with which the user is associated.
deviceOSstringThe operating system platform.
osPlatformstringThe operating system platform on the user device.
versionAtTheTimeOfUpgradestringThe current inSync Client version when the upgrade is initiated.
upgradeTostringThe inSync Client version being upgraded to.
statusstringThe status of the upgrade operation. Example- Success, In progress, Failed, Scheduled
detailsstringThe details of the upgrade action.
upgradeAttemptstringThe date and time when the upgrade was triggered. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
dateScheduledOnstringThe date and time when the upgrade is scheduled. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
scheduledBystringThe email-ID of cloud administrator/client who initiated the upgrade.
typeOfUpgradestringThe 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.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectFilters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of alerts.
entitystringThe username and device of the user.
alertDetailsstringThe details about the alert generated.
firstOccurencestringThe 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
lastOccurencestringThe 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
activestringThe information whether the alert generated is active or not.
severitystringThe severity type of the alert. Example:- critical, high, warning.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectThe filters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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": {},
FieldTypeDescription
dataarray of objectsThe collection of restore activities.
lastUpdatedTimestringThe last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
startTimestringThe date and time on which the restore operation started. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
endTimestringThe date and time on which the restore operation was completed. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userNamestringThe name of the user whose device is restored.
userEmailIDstringThe email address of the user whose device is restored.
dataSourcestringThe name of the device that is registered for the user.
profilestringThe profile that is assigned to the user.
modestringThe type of restore operation based on its origin. For example, Admin, Web, self, or mobile.
systemSettingRestorestringIf the restore is performed with system settings this field will display the value as Yes, if not it will display as No.
filesintegerThe number of files that were selected for the restore operation.
filesSkippedintegerThe number of files that were missed from the restore activity.
restoreSizeintegerThe number of bytes in MB that were restored.
statusstringThe status of the restore operation.
cplatformstringThe operating system of the device.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectThe filters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of deleted devices.
lastUpdatedTimestringThe last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
deviceNamestringThe name of the deleted device.
userNamestringThe name of the user whose device was deleted.
userStatusstringThe status of the user the deleted device is associated with. Example - Active, Preserved or Deleted.
profileNamestringThe name of the profile the user is associated with.
lastBackupStatusstringThe 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.
lastCompletedBackupstringThe 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.
backupDataMBintegerThe total size of backed-up data for the device. Total size is a combination of incremental and differential backup data for the device.
deviceOSstringThe operating system of the device.
lastConnectedstringThe 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.
deletedOnstringThe date and time when the device was deleted. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z.
deletedBystringThe 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.
userEmailIDstringThe email address of the user whose device was deleted.
customAttributeValuestringThe name of the attribute in the AD server.
customAttributeNamestringThe value of the attribute in the AD server.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectThe filters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of license usage data.
fromDatestringThe 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
toDatestringThe 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
usersAddedintegerThe total number of users added for a given week or a given month.
usersDeletedintegerThe total number of users deleted for a given week or a given month (based on whether the report is weekly or monthly).
totalActiveLicenseintegerThe 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).
activeLicenseUsedintegerThe 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).
totalPreservedLicenseintegerThe 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).
preservedLicenseUsedintegerThe 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).
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectThe filters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of inactive devices data.
lastUpdatedTimestringThe last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
deviceNamestringThe name of the inactive device as registered with Endpoints.
deviceStatusstringThe status assigned to the device in Endpoints. Can be enabled or disabled.
userNamestringThe user name to whom the inactive device belongs.
licensestringThe status of the license associated with the inactive device. For example, Active or Preserve.
profileNamestringThe name of the profile associated with the inactive device.
lastCompletedBackupstringThe 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.
lastConnectedstringThe 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.
autoDeleteOnstringThe 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.
userEmailIDstringThe email ID of the user to whom the inactive device belongs.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectThe filters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of preserved users data.
lastUpdatedTimestringThe last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userNamestringThe username of the preserved user.
userEmailIDstringThe email address of the preserved user.
profileNamestringThe profile name assigned to the preserved user.
endpointsLicensestringThe Endpoints license status of the user. For example, preserved or "-" where"-" indicates as unlicensed state.
preservedOnstringThe date on which the user was preserved. The time is in the UTC time zone. Example - 2019-10-25
modestringThe 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.
autoDeleteOnstringThe system calculated date on which the user will be deleted if endpoints are configured to auto-delete preserved users,.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectThe filters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of user rollout data.
lastUpdatedTimestringThe last updated time stamp for the record. The time is in the UTC time zone. Example - 2019-10-25T00:00:00Z
userNamestringThe user name to whom the device belongs.
userEmailstringThe email ID of the user to whom the device belongs.
customAttributeValuestringThe value of the attribute in the AD server.
customAttributeNamestringThe name of the attribute in the AD server.
addedOnstringThe date and time when the user was added. The time is in the UTC time zone.
profileNamestringThe name of the profile with which the user is associated.
licenseDatastringThe status of the license of the workload, the data source belongs to. For example, active, preserve or "-", where "-" indicates unlicensed state.
sourcestringThe name of the device which the user is associated with.
activatedOnstringThe date and time when the device was activated.
systemSettingsstringThe status of whether the device's system settings were backed up.
lastBackupStatusstringThe status of the last backup operation.
lastBackupTimestringThe time taken(Unix format) for the last backup operation to complete in hours and minutes.
firstBackupStatusstringThe status of the first backup operation.
firstBackupSizeMBstringThe size of the files in MB that were backed up during the last backup operation.
bytesTransferredMBstringThe number of bytes transferred during backup.
timeTakenHhMmstringThe time taken for the backup operation to complete in hours and minutes.
clientVersionstringThe version of inSync Client on the user device.
osPlatformstringThe operating system platform on the user device.
lastUpgradedOnstringThe date and time when the inSync Client on the user device was last upgraded. Example - 2019-10-25T00:00:00Z.
upgradeStatestringThe upgrade state of inSync Client on the user device. This field shows one of the following values- UPGRADEABLE, NOT UPGRADABLE, UPTODATE
deviceOSstringThe operating system platform on the user device.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectThe filters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan 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="
}
FieldTypeDescription
dataarray of objectsThe collection of user data.
fromDatestringThe 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
toDatestringThe 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
totalUsersintegerThe total number of users available in Endpoints for a given week or month.
totalPreservedUsersintegerThe total number of users that are preserved in Endpoints to date for a given week or month.
usersAddedintegerThe number of users that are added to Endpoints for a given week or month.
usersDeletedintegerThe number of users that are deleted from Endpoints for a given week or month.
usersPreservedintegerThe number of users that are preserved in Endpoints for a given week or month.
lastSyncTimestampdate-timeThe time stamp until which the report data was returned. The time is in the UTC time zone.
filtersobjectThe filters applied on the report.
nextPageTokenstringThe 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
}
FieldTypeDescription
codestringError code.
dataobjectData of the error.
messagestringError message.
retryablebooleanCan retry the API call (true for yes and false for no.)